Package com.appliedolap.essbase.impl

Class EssConnectionImpl

java.lang.Object
com.appliedolap.essbase.AbstractEssObject
com.appliedolap.essbase.impl.EssConnectionImpl
All Implemented Interfaces:
EssConnection, EssObject
public class EssConnectionImpl extends AbstractEssObject implements EssConnection
A global connection on the server.

  • 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
      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
      Returns:
      the object type

    • getConnectionType

      public EssConnection.ConnectionType getConnectionType()
      Specified by:
      getConnectionType in interface EssConnection

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface EssConnection

    • getPath

      public String getPath()
      Description copied from interface: EssConnection
      For a file connection, the catalogue path of the file - /gallery/Technical/Filters/UserDetails.csv. Null for a connection that isn't file-based.
      Specified by:
      getPath in interface EssConnection
      Returns:
      the path, or null

    • getHost

      public String getHost()
      Description copied from interface: EssConnection
      The host a database connection points at, or null for a file connection.
      Specified by:
      getHost in interface EssConnection

    • test

      public Optional<String> test()
      Tests the saved connection.

      A failure is an answer rather than an error - the caller asked whether it works - so the server's reason comes back instead of an exception. For a database connection on a server without the right driver that reason is an ORA- code from Oracle's driver, whatever type the connection claims to be.

      Specified by:
      test in interface EssConnection
      Returns:
      empty when it connects, otherwise the server's reason

    • delete

      public void delete()
      Specified by:
      delete in interface EssConnection

    • getProperties

      public Map<String,Object> getProperties()
      Everything the server said about this connection, for a caller wanting more than the accessors.

    • toString

      public String toString()
      Overrides:
      toString in class Object