Package com.appliedolap.essbase.impl

Class EssUtilityImpl

java.lang.Object
com.appliedolap.essbase.AbstractEssObject
com.appliedolap.essbase.impl.EssUtilityImpl
All Implemented Interfaces:
EssObject, EssUtility
public class EssUtilityImpl extends AbstractEssObject implements EssUtility
Represents one of the downloadable utilities on the Essbase server.

  • Constructor Details

    • EssUtilityImpl

      public EssUtilityImpl(ApiContext api, com.appliedolap.essbase.client.model.Resource resource)

  • Method Details

    • getName

      public String getName()
      Description copied from interface: EssObject
      Gets the name of this object. This will generally be the "nice" and "unique" name of this object, such as the application name, cube, member, variable, or whatever.
      Specified by:
      getName in interface EssObject
      Specified by:
      getName in interface EssUtility
      Returns:
      the simple name of this object

    • getType

      public EssObject.Type getType()
      Description copied from interface: EssObject
      Gets the type of this object.
      Specified by:
      getType in interface EssObject
      Specified by:
      getType in interface EssUtility
      Returns:
      the object type

    • isDownloadable

      public boolean isDownloadable()
      Description copied from interface: EssUtility
      Checks if the utility is downloadable, as opposed to being a direct link. In reviewing the current response format, the list of utilities includes, for example, a link to the index.html page in the url variable when it's a link to a web page (and no links item), and in the case of an actually downloadable utility, the links item will exist and may look like the following: 
       "links": [
   {
     "rel": "download",
     "href": "https://129.159.71.17:443/essbase/rest/v1/utilities/cli",
     "method": "get",
     "type": "application/zip"
   }
      Specified by:
      isDownloadable in interface EssUtility
      Returns:
      true if the resource is a downloadable file, false if not (such as in the case of a generic link)

    • download

      public void download()
      Specified by:
      download in interface EssUtility