Package com.appliedolap.essbase

Interface EssApplication

All Superinterfaces:
EssObject
All Known Implementing Classes:
EssApplicationImpl
public interface EssApplication extends EssObject

  • Method Details

    • getServer

      EssServer getServer()
      Get the server that contains this application.
      Returns:
      the parent server for the application

    • getCreated

      Instant getCreated()
      Gets the created time for this application.
      Returns:
      when the application was created

    • getModified

      Instant getModified()
      Gets the modified time for this application.
      Returns:
      the modified time for this application

    • getCubes

      List<EssCube> getCubes()
      Gets the list of cubes in this application.
      Returns:
      the list of cubes for this application, or an empty list if there are none

    • getCube

      EssCube getCube(String cubeName)
      Gets a cube with the given name.
      Parameters:
      cubeName - the name of the cube
      Returns:
      the cube

    • copy

      void copy(String copyName)
      Copies this application to a new application with the given name.
      Parameters:
      copyName - the name of the copy

    • delete

      void delete()
      Deletes this application.

    • rename

      void rename(String newName)
      Renames this application.
      Parameters:
      newName - the new name for the application

    • getConfigurations

      List<EssApplicationConfiguration> getConfigurations()
      Gets the list of configuration for this application.
      Returns:
      the configurations

    • getJobs

      List<EssJob> getJobs()
      Get the list of jobs associated with this application. In the Essbase REST API there is no specific endpoint for jobs related to an application, but the general jobs service can take an application name to filter on. So this implementation serves as a convenience method to get the jobs specific to this application.
      Returns:
      list of jobs for this application, empty list if none

    • getVariables

      List<EssApplicationVariable> getVariables()
      Gets the list of variables specific to this application
      Returns:
      the application variables

    • getStatus

      EssApplication.Status getStatus()
      Gets the status of this application. Known statuses are simply STOPPED and STARTED; other statuses, if they exist, are not known at this time and will simply get converted to UNKNOWN.

      Note that this status represents the status when this object was instantiated. In other words, if the status of the app changes during the lifetime of this object, it won't be refreshed automatically.

      Returns:
      the status of this application

    • stop

      void stop()
      Stops the application.

    • start

      void start()
      Starts the application

    • downloadLatestLog

      void downloadLatestLog(OutputStream outputStream)
      Writes the latest application log to the given output stream.
      Parameters:
      outputStream - the output stream

    • downloadAllLogsAsZip

      void downloadAllLogsAsZip(OutputStream outputStream)
      Writes all logs to the given output stream.
      Parameters:
      outputStream - the output stream