Interface Bamboo

All Known Implementing Classes:
BambooContainer

public interface Bamboo
This interface provides a simple Facade for accessing Bamboo.

This acts as a uniform API for accessing the system - web actions, soap calls and such like all use this interface.

  • Field Details

    • BAMBOO_KEY

      static final String BAMBOO_KEY
      The key for the Bamboo instance stored in the action's servlet context
      See Also:
  • Method Details

    • start

      void start(@NotNull @NotNull javax.servlet.ServletContext servletContext) throws Exception
      Start Bamboo
      Throws:
      Exception
    • stop

      @Deprecated void stop()
      Deprecated.
      since 5.10
      Stop bamboo
    • restartComponentsFollowingConfigurationChange

      @Deprecated void restartComponentsFollowingConfigurationChange()
      Deprecated.
      since 5.10
      Restart the components that depend on the current system configuration whenever the configuration has been changed.
    • getErrorMessages

      @Deprecated Collection<ErrorDetails> getErrorMessages()
      Deprecated.
      since 5.10
      Obtain all of the system logged error messages
      Returns:
      the collection of ErrorMessages
    • getErrorMessages

      @Deprecated Collection<ErrorDetails> getErrorMessages(@NotNull @NotNull PlanKey planKey)
      Deprecated.
      since 5.10
      Obtain all of the system logged error messages
      Returns:
      the collection of ErrorMessages
    • getErrorMessagesByAgentId

      @Deprecated Collection<ErrorDetails> getErrorMessagesByAgentId(@NotNull @NotNull Long agentId)
      Deprecated.
      since 5.10
      Obtain the system logged error messages filtered by Agent Id
      Parameters:
      agentId -
      Returns:
      the collection of ErrorMessages
    • getElasticErrorMessages

      @Deprecated Collection<ErrorDetails> getElasticErrorMessages()
      Deprecated.
      since 5.10
      Obtain all of the logged error messages associated with elastic bamboo
      Returns:
      the collection of ErrorDetails objects
    • clearErrorMessages

      @Deprecated void clearErrorMessages()
      Deprecated.
      since 5.10
      deletes all error messages
    • removeBuildErrorFromLog

      @Deprecated void removeBuildErrorFromLog(String buildName, int errorNumber)
      Deprecated.
      since 5.10
      Remove the errorNumber'th error for the given buildName from the internal system error log
      Parameters:
      buildName - The name of the build with the associated error
      errorNumber - The error number (zero based index of error associated with build)
    • getBuildErrorDetails

      @Deprecated ErrorDetails getBuildErrorDetails(String buildName, int errorNumber)
      Deprecated.
      since 5.10
      Obtain the errorNumber'th error for the given buildName from the internal system error log
      Parameters:
      buildName - The name of the build with the associated error
      errorNumber - The error number (zero based index of error associated with build)
    • getDefaultPersister

      @Deprecated Persister getDefaultPersister()
      Deprecated.
      since 5.10
    • getSessionManager

      SessionManager getSessionManager()
      Which session manager is the system using?
      Returns:
      The session manager
    • getAdministrationConfiguration

      @Deprecated AdministrationConfiguration getAdministrationConfiguration()
      Deprecated.
      5.10