Skip navigation links


com.essbase.api.session
Interface IEssbase

All Superinterfaces:
IEssBaseObject

public interface IEssbase
extends IEssBaseObject

The IEssbase represent client sessions with the Essbase.

Version:
1.0, 04/04/2001
Author:
Srini Ranga

Nested Class Summary
static class IEssbase.EEssAuthenticatorType
          The EEssAuthenticatorType is an enumeration of user authenticators.
static class IEssbase.EEssOrbPluginType
          The EEssOrbPluginType is an enumeration of supported ORB plug-in types.
static class IEssbase.Home
          The Home is a factory for creating JAPI instances.

 

Field Summary
static java.lang.String JAPI_VERSION
          Essbase JAPI version.

 

Method Summary
 void addInstanceForParallelDataload(java.lang.String rulesFile, int dataFileType, java.lang.String dataFile, boolean abortOnError, long duplicateAggregationMethod, long initOption, java.lang.String userName, java.lang.String password, long commitOption, long actionType, long termOption)
          API for parallel ASO dataloads.
 void changePassword(java.lang.String newPassword)
          Deprecated. This function has been deprecated.
 void clearInstancesForDataload()
          API for parallel ASO dataloads.
 IEssCollection createIEssCollection()
          Creates an object for the interface IEssCollection.
 IEssValueAny createIEssValueAny()
          Creates an object for the interface IEssValueAny.
 java.lang.String getApiVersion()
          Gets the version of the Essbase JAPI.
 java.lang.String getApiVersionDetail()
          Gets details about this JAPI version and the compatibility info with the client it is compiled with.
 java.lang.String getCssToken()
          Deprecated. This functionality has been deprecated.
 java.lang.String getDomainName()
          Deprecated. This functionality has been deprecated.
 IEssLocationInfo[] getLocationInfoForRunningEnterpriseServers()
          Gets the location information for the running Enterprise server instances.
 int getNetRetryCount()
          Gets the count of maximum retry attempts in case a connection cannot be established with the EDS server.
 int getNetRetryInterval()
          Gets the interval (in milliseconds) between retry attempts in case a connection cannot be established with the EDS server.
 IEssDomain getRootDomain()
          Gets the root domain of the domain forest.
 java.lang.String getServerVersionDetail()
          Gets details about the EDS version that this JAPI is connected to.
 IEssSession[] getSessions()
          Gets information about sessions of all the users signed on to EDS server.
 java.lang.String[][] getStatusForDataload()
          API for parallel ASO dataloads.
 java.util.Locale getUserLocale()
          Returns the locale applied for this session.
 java.lang.String getUserName()
          Gets the name of the signed on user name.
 boolean isAssertionsEnabled()
          Checks if assertions are enabled.
 boolean isDedicatedServerThreadNeeded()
          Deprecated. This functionality has been deprecated.
 boolean isGlobalClientCachingEnabled()
          Deprecated. This functionality has been deprecated.
 boolean isSecureCommunicationEnabled()
          Checks if secure communication (SSL) is enabled.
 boolean isSignedOn()
          Checks if the user is signed on to a domain.
 java.lang.String restoreCssToken(java.lang.String token)
          Deprecated. This functionality has been deprecated.
 void setAssertionsEnabled(boolean assertionsEnabled)
          Sets if assertions are enabled.
 void setCommonBufferTermOptions(long commitOption, long actionType, long termOption)
          API for parallel ASO dataloads.
 void setDedicatedServerThreadNeeded(boolean needDedicatedServerThread)
          Deprecated. This functionality has been deprecated.
 void setGlobalClientCachingEnabled(boolean enableCaching)
          Deprecated. This functionality has been deprecated.
 void setNetRetryCount(int netRetryCnt)
          Sets the count of maximum retry attempts in case a connection cannot be established with the EDS server.
 void setNetRetryInterval(int netRetryInvl)
          Sets the interval (in milliseconds) between retry attempts in case a connection cannot be established with the EDS server.
 void setOAMParams(java.lang.String user, java.lang.String password, java.lang.String languages)
          Sets credentials required for OAM.
 void setSecureCommunicationEnabled(boolean secureCommunication)
          Sets if secure communication (SSL) is enabled.
 void setUserLocale(java.util.Locale locale, boolean override)
          Sets the user specific locale for this session.
 void signOff()
          Signs off the user from the Essbase domain.
 IEssDomain signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl)
          Signs on the user to the essbase domain.
 IEssOlapServer signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl, java.lang.String olapServerName)
          Signs on the user to the essbase domain.
 IEssDomain signOn(java.lang.String cssToken, java.lang.String domainName, java.lang.String providerUrl)
          Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl) instead.
 IEssDomain signOn(java.lang.String cssToken, java.lang.String domainName, java.lang.String prefEesSvrName, IEssbase.EEssOrbPluginType orbPluginType, int port)
          Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl) instead.
 IEssDomain signOn(java.lang.String userName, java.lang.String password, java.lang.String domainName, java.lang.String providerUrl)
          Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl) instead.
 IEssOlapServer signOn(java.lang.String cssToken, java.lang.String domainName, java.lang.String providerUrl, java.lang.String olapServerName, boolean bReserved)
          Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl, java.lang.String olapServerName) instead.
 IEssDomain signOn(java.lang.String userName, java.lang.String password, java.lang.String domainName, java.lang.String prefEesSvrName, IEssbase.EEssOrbPluginType orbPluginType, int port)
          Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl) instead.
 IEssOlapServer signOn(java.lang.String userName, java.lang.String password, java.lang.String domainName, java.lang.String providerUrl, java.lang.String olapServerName)
          Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl, java.lang.String olapServerName) instead.
 java.lang.String[][] startParallelDataload(java.lang.String serverName, java.lang.String olapUserName, java.lang.String OlapPassword, boolean isPasswordToken, java.lang.String providerURL, java.lang.String appName, java.lang.String cubeName, int StartBufferId)
          API for parallel ASO dataloads.

 

Field Detail

JAPI_VERSION

static final java.lang.String JAPI_VERSION
Essbase JAPI version.
See Also:
Constant Field Values

Method Detail

getApiVersion

java.lang.String getApiVersion()
                               throws com.essbase.api.base.EssException
Gets the version of the Essbase JAPI. Returns the Release string.
Returns:
The JAPI version. Eg: For Beckett it returns "9.3.0"
Throws:
com.essbase.api.base.EssException - if an error occurs.

getApiVersionDetail

java.lang.String getApiVersionDetail()
                                     throws com.essbase.api.base.EssException
Gets details about this JAPI version and the compatibility info with the client it is compiled with. Returns complete details with major, minor and build number details. Eg: Analytic Services JAPI version: 9.3.0.0 Build 291
Returns:
The JAPI version details.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getServerVersionDetail

java.lang.String getServerVersionDetail()
                                        throws com.essbase.api.base.EssException
Gets details about the EDS version that this JAPI is connected to.
Returns:
The EDS server version details.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getUserName

java.lang.String getUserName()
                             throws com.essbase.api.base.EssException
Gets the name of the signed on user name.
Returns:
The signed on user name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDomainName

java.lang.String getDomainName()
                               throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the name of the signed on Essbase domain name.
Returns:
The signed on domain name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isGlobalClientCachingEnabled

boolean isGlobalClientCachingEnabled()
                                     throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Checks if global client caching is enabled.
Returns:
true if global client caching is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setGlobalClientCachingEnabled

void setGlobalClientCachingEnabled(boolean enableCaching)
                                   throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Sets if global client caching is enabled. When a new Object is created in the object hierarchy of this API instance, it inherits this flag as part of its initial object caching status. But each individual object can be set to have a different caching status than the global status, at any time after the creation, and later takes precedence over the global status.
Parameters:
enableCaching - true if global caching is to be enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isSecureCommunicationEnabled

boolean isSecureCommunicationEnabled()
                                     throws com.essbase.api.base.EssException
Checks if secure communication (SSL) is enabled. (FUTURE USE)
Returns:
true if secure communication is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setSecureCommunicationEnabled

void setSecureCommunicationEnabled(boolean secureCommunication)
                                   throws com.essbase.api.base.EssException
Sets if secure communication (SSL) is enabled. (FUTURE USE) Secure communication can be enabled or disabled at any execution point of your client program and as many times as needed. For eg, here is a sequence of operations: enable secure communication, sign on, list users, disable secure communication, list groups. In this example, sign on and list users are secure and list groups is not. Be aware that the secure communication has a little performance overhead, becase of encoding and other security related handshakes, between the JAPI client and the enterprise server. Also, for secure communication to work, the enterprise server has to be configured to enable secure communication. By default, secure communication is not enabled.
Parameters:
secureCommunication - true if secure communication is to be enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getNetRetryCount

int getNetRetryCount()
                     throws com.essbase.api.base.EssException
Gets the count of maximum retry attempts in case a connection cannot be established with the EDS server. This method can be used anytime before or after sign on.
Returns:
The count of maximum retry attempts.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setNetRetryCount

void setNetRetryCount(int netRetryCnt)
                      throws com.essbase.api.base.EssException
Sets the count of maximum retry attempts in case a connection cannot be established with the EDS server. This method can be used anytime before or after sign on. If you get 'connection refused' errors adjust this value till you don't see the error.
Parameters:
netRetryCnt - The count of maximum retry attempts.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getNetRetryInterval

int getNetRetryInterval()
                        throws com.essbase.api.base.EssException
Gets the interval (in milliseconds) between retry attempts in case a connection cannot be established with the EDS server. This method can be used anytime before or after sign on.
Returns:
The interval between retry attempts.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setNetRetryInterval

void setNetRetryInterval(int netRetryInvl)
                         throws com.essbase.api.base.EssException
Sets the interval (in milliseconds) between retry attempts in case a connection cannot be established with the EDS server. This method can be used anytime before or after sign on. If you get 'connection refused' errors adjust this value till you don't see the error.
Parameters:
netRetryInvl - The interval between retry attempts.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isDedicatedServerThreadNeeded

boolean isDedicatedServerThreadNeeded()
                                      throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Checks if this JAPI client needs dedicated server thread for the lifetime of the session. This method is useful only for orb plugin type of tcp/ip.
Returns:
true if this JAPI client needs dedicated server thread (i.e thread per session for this JAPI client).
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
6.5.3

setDedicatedServerThreadNeeded

void setDedicatedServerThreadNeeded(boolean needDedicatedServerThread)
                                    throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Sets if this JAPI client needs dedicated server thread for the life time of the session. If you pass true to the argument, the server will try to dedicate a thread (thread per session for this client) but it is not guaranteed. If you pass false to the argument, the server will switch to thread per operation for this client. You can invoke this method with different values for the parameter several times during the lifetime of the session. If your system will have only a fewer number of clients, having dedicated server thread per client will improve performance. This method will work only for orb plugin type of tcp/ip, and will not have any effect for http. Invoke this method before invoking signOn().
Parameters:
needDedicatedServerThread - true to let the server know to dedicate a thread for this JAPI client.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
6.5.3

isAssertionsEnabled

boolean isAssertionsEnabled()
                            throws com.essbase.api.base.EssException
Checks if assertions are enabled.
Returns:
true if assertions are enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
6.5.3

setAssertionsEnabled

void setAssertionsEnabled(boolean assertionsEnabled)
                          throws com.essbase.api.base.EssException
Sets if assertions are enabled. Ideally you may want to enable assertions during development and testing phase, and disable assertions at production. Disabling the assertions will improve the performance. Assetions are enabled by default.
Parameters:
assertionsEnabled - true if assertions are enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
6.5.3

getLocationInfoForRunningEnterpriseServers

IEssLocationInfo[] getLocationInfoForRunningEnterpriseServers()
                                                              throws com.essbase.api.base.EssException
Gets the location information for the running Enterprise server instances. You can invoke this method before or after sign on. This method will not detect enterprise servers on the other side of the firewall, and can only be used inside an intranet.
Returns:
The list of location information of enterprise servers.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setUserLocale

void setUserLocale(java.util.Locale locale,
                   boolean override)
                   throws com.essbase.api.base.EssException
Sets the user specific locale for this session. The locale be considered for generating error messages to the user. This can be used any time during a valid session to change the locale. But Override parameter will have effect only when this API is invoked before the sign-on call. Override indicates which locale info(user specified/server specified) should prevail.
Parameters:
locale - - a locale from the list of locales that Provider services/JAPI support
override - - false if user specified locale should prevail; defaults to true
Throws:
com.essbase.api.base.EssException
Since:
11.1.2.0.00

getUserLocale

java.util.Locale getUserLocale()
                               throws com.essbase.api.base.EssException
Returns the locale applied for this session. Will return null if used before sign-on.
Returns:
- Locale applied to this session.
Throws:
com.essbase.api.base.EssException

setOAMParams

void setOAMParams(java.lang.String user,
                  java.lang.String password,
                  java.lang.String languages)
                  throws com.essbase.api.base.EssException
Sets credentials required for OAM. Use this API before the sign-on call. Credentials must be specified using this, if token is used for authentication during sign-on. If credentials are not specified using this API and username/password are specified for sign-on instead of token, then the username/password details specified for sign-on will be used for OAM authentication as well.
Parameters:
user - - the user name with OAM authorization
password - - the password
languages - - preferred locale, defaults to en-US.
Throws:
com.essbase.api.base.EssException
Since:
11.1.2

signOn

IEssDomain signOn(java.lang.String userName,
                  java.lang.String password,
                  java.lang.String domainName,
                  java.lang.String prefEesSvrName,
                  IEssbase.EEssOrbPluginType orbPluginType,
                  int port)
                  throws com.essbase.api.base.EssException
Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl) instead.
Signs on the user to the essbase domain.
Parameters:
userName - The user name.
password - The user password.
domainName - The hierachical name of the domain.
prefEesSvrName - The preferred Provider Server name.
orbPluginType - The orb plugin type.
port - Port number where enterprise server is installed. This param is to be specified only if the orbPluginType is HTTP. Just pass 0 for other types.
Returns:
The signed on domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

signOn

IEssDomain signOn(java.lang.String cssToken,
                  java.lang.String domainName,
                  java.lang.String prefEesSvrName,
                  IEssbase.EEssOrbPluginType orbPluginType,
                  int port)
                  throws com.essbase.api.base.EssException
Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl) instead.
Signs on the user to the essbase domain.
Parameters:
cssToken - The token from prior CSS authentication.
domainName - The hierachical name of the domain.
prefEesSvrName - The preferred Provider Server name.
orbPluginType - The orb plugin type.
port - Port number where enterprise server is installed. This param is to be specified only if the orbPluginType is HTTP. Just pass 0 for other types.
Returns:
The signed on domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

signOn

IEssDomain signOn(java.lang.String userName,
                  java.lang.String password,
                  java.lang.String domainName,
                  java.lang.String providerUrl)
                  throws com.essbase.api.base.EssException
Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl) instead.
Signs on the user to the essbase domain. This method can be used if you want to communicate to Provider Server running as a servlet, using http.
Parameters:
userName - The user name.
password - The user password.
domainName - The hierachical name of the domain.
providerUrl - The url of the Analytic Services Provider servlet (For embedded mode pass "embedded").
Returns:
The signed on domain.
Throws:
com.essbase.api.base.EssException - if an error occurs. Error codes: IEssException.ERROR_INVALID_USER_OR_PASSWORD.

signOn

IEssDomain signOn(java.lang.String cssToken,
                  java.lang.String domainName,
                  java.lang.String providerUrl)
                  throws com.essbase.api.base.EssException
Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl) instead.
Signs on the user to the essbase domain. This method can be used if you want to communicate to Provider Server running as a servlet, using http.
Parameters:
cssToken - The token from prior CSS authentication.
domainName - The hierachical name of the domain.
providerUrl - The url of the Analytic Services Provider servlet (For embedded mode pass "embedded").
Returns:
The signed on domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

signOn

IEssDomain signOn(java.lang.String userName,
                  java.lang.String password,
                  boolean passwordIsToken,
                  java.lang.String userNameAs,
                  java.lang.String providerUrl)
                  throws com.essbase.api.base.EssException
Signs on the user to the essbase domain. This method can be used if you want to communicate to Provider Server running as a servlet, using http.
Parameters:
userName - The user name. Can be null of password is cssToken and the passwordIsToken flag is true.
password - The user password. Cannot be null. If the passwordIsToken flag is true, this represents the cssToken string.
passwordIsToken - A boolean indicating whether the password is cssToken string.
userNameAs - The user name you want to impersonate. If null, no impersonation occurs.
providerUrl - The url of the Analytic Services Provider servlet (For embedded mode pass "embedded"). In the embedded mode the JAPI client and provider are in the same process space and JAPI talks to the olap server directly. (No separate provider application need to be running.)
Returns:
The signed on domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

signOn

IEssOlapServer signOn(java.lang.String userName,
                      java.lang.String password,
                      java.lang.String domainName,
                      java.lang.String providerUrl,
                      java.lang.String olapServerName)
                      throws com.essbase.api.base.EssException
Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl, java.lang.String olapServerName) instead.
Signs on and connects to the specified olap server.
Parameters:
userName - The user name.
password - The password.
domainName - The EDS domain name.
providerUrl - The url of the Analytic Services Provider servlet (For embedded mode pass "embedded").
olapServerName - The host name where the analytic server is running.
Returns:
The olap server object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

signOn

IEssOlapServer signOn(java.lang.String cssToken,
                      java.lang.String domainName,
                      java.lang.String providerUrl,
                      java.lang.String olapServerName,
                      boolean bReserved)
                      throws com.essbase.api.base.EssException
Deprecated. This function has been deprecated. The preferred method is signOn(java.lang.String userName, java.lang.String password, boolean passwordIsToken, java.lang.String userNameAs, java.lang.String providerUrl, java.lang.String olapServerName) instead.
Signs on the user to the essbase domain. This method can be used if you want to communicate to Provider Server running as a servlet, using http.
Parameters:
cssToken - The token from prior CSS authentication.
domainName - The hierachical name of the domain.
providerUrl - The url of the Analytic Services Provider servlet (For embedded mode pass "embedded").
olapServerName - The host name where the analytic server is running.
bReserved - For future use.
Returns:
The olap server object.
Throws:
com.essbase.api.base.EssException - if an error occurs.

signOn

IEssOlapServer signOn(java.lang.String userName,
                      java.lang.String password,
                      boolean passwordIsToken,
                      java.lang.String userNameAs,
                      java.lang.String providerUrl,
                      java.lang.String olapServerName)
                      throws com.essbase.api.base.EssException
Signs on the user to the essbase domain. This method can be used if you want to communicate to Provider Server running as a servlet, using http. This method signs on the user to provider and also connects to the olap server.
Parameters:
userName - The user name. Can be null of password is cssToken and the passwordIsToken flag is true.
password - The user password. Cannot be null. If the passwordIsToken flag is true, this represents the cssToken string.
passwordIsToken - A boolean indicating whether the password is cssToken string.
userNameAs - The user name you want to impersonate. If null, no impersonation occurs.
providerUrl - The url of the Analytic Services Provider servlet (For embedded mode pass "embedded"). In the embedded mode the JAPI client and provider are in the same process space and JAPI talks to the olap server directly. (No separate provider application need to be running.)
olapServerName - The host name where the analytic server is running.
Returns:
The connected olap server instance.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCssToken

java.lang.String getCssToken()
                             throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the token associated with CSS authentication. Non null value is returned for EEssAuthenticatorType of CSS and null value is returned for the rest.
Returns:
Token for CSS authentication.
Throws:
com.essbase.api.base.EssException

restoreCssToken

java.lang.String restoreCssToken(java.lang.String token)
                                 throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Restores a timed out CSS token by resetting the timeout counter in the token, thereby extending the life of the token for future usage.
Parameters:
token - The timed out token.
Returns:
The new token.
Throws:
com.essbase.api.base.EssException

getSessions

IEssSession[] getSessions()
                          throws com.essbase.api.base.EssException
Gets information about sessions of all the users signed on to EDS server.
Returns:
The sessions.
Throws:
com.essbase.api.base.EssException - if an error occurs.

signOff

void signOff()
             throws com.essbase.api.base.EssException
Signs off the user from the Essbase domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

isSignedOn

boolean isSignedOn()
                   throws com.essbase.api.base.EssException
Checks if the user is signed on to a domain.
Returns:
true, if the user is signed on.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getRootDomain

IEssDomain getRootDomain()
                         throws com.essbase.api.base.EssException
Gets the root domain of the domain forest.
Returns:
The root Essbase domain.
Throws:
com.essbase.api.base.EssException - if an error occurs.

changePassword

void changePassword(java.lang.String newPassword)
                    throws com.essbase.api.base.EssException
Deprecated. This function has been deprecated.
Changes the password for the signed on user.
Parameters:
newPassword - The new password.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssValueAny

IEssValueAny createIEssValueAny()
                                throws com.essbase.api.base.EssException
Creates an object for the interface IEssValueAny.
Returns:
The IEssValueAny interface.
Throws:
com.essbase.api.base.EssException - if an error occurs.

createIEssCollection

IEssCollection createIEssCollection()
                                    throws com.essbase.api.base.EssException
Creates an object for the interface IEssCollection.
Returns:
The IEssCollection interface.
Throws:
com.essbase.api.base.EssException - if an error occurs.

addInstanceForParallelDataload

void addInstanceForParallelDataload(java.lang.String rulesFile,
                                    int dataFileType,
                                    java.lang.String dataFile,
                                    boolean abortOnError,
                                    long duplicateAggregationMethod,
                                    long initOption,
                                    java.lang.String userName,
                                    java.lang.String password,
                                    long commitOption,
                                    long actionType,
                                    long termOption)
                                    throws com.essbase.api.base.EssException
API for parallel ASO dataloads. Creates a dataload instance for either data file or a SQL data source. Invoke this API repeatedly to add mulitple dataload sources. Each instance should represent either a SQL data source or a data file and should not represent both. Allows a max of 8 instances. Requires the params for LoadBufferInit and LoadBufferTerm to be specified while adding the instance. LoadBufferTerm params can be overridden for better performance setCommonBufferTermOptions(long, long, long). Below is the example sequence of the code IEssbase essbase = IEssbase.Home.create(IEssbase.JAPI_VERSION); essbase.addInstanceForParallelDataload("dataload", IEssOlapFileObject.TYPE_TEXT, "dataload1", false, 0, 0, null, null, 1, 1, 0); essbase.addInstanceForParallelDataload("loadFile", 0, null, false, 0, 0, "DBuser", "DBpassword", 1, 1, 0); essbase.setCommonBufferTermOptions(1, 1, 0); String[][] err = essbase.startParallelDataload("hostname", "system", "password", false, "Embedded", "ASOSamp", "Sample", 50); String [][] status = essbase.getStatusForDataload(); for (int i=0; i < status.length; i++) { System.out.println("Status for Buffer " + status[i][0] + " is " + status[i][1] + " " + status[i][2]); } for (int i=0; err != null && i < err.length; i++) { System.out.println(err[i][0]+ " " +err[i][1] + " " + err[i][2] + " " + err[i][3]); } essbase.clearInstancesForDataload();
Parameters:
rulesFile - - String, the rule file
dataFileType - - int, the data file type, specify 0 if SQL source
dataFile - - String, the data file, specify null if SQL source
abortOnError - - If true, data load stops on the first error record. Otherwise, data load continues.
duplicateAggregationMethod - - method to use for collision resolution within the buffer. One of the following constants describing how to combine multiple values for the same cell within the buffer Values are: ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ADD 0 ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_ASSUME_EQUAL 1 ESS_ASO_DATA_LOAD_BUFFER_DUPLICATES_USE_LAST 2
initOption - - a combination of the AD_UKR_LOAD_BUFFER_OPTION_XXX constants. Use bitwise OR (|) to specify multiple ulOptions; for example, ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES | ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES. values are: ESS_ASO_DATA_LOAD_BUFFER_IGNORE_MISSING_VALUES 0x00000001 ESS_ASO_DATA_LOAD_BUFFER_IGNORE_ZERO_VALUES 0x00000002
userName - - the username for SQL source, specify null if data file is source
password - - the password for SQL user, specify null if data file is source
commitOption - - * values are: ESS_ASO_DATA_LOAD_BUFFER_STORE_DATA 0 ESS_ASO_DATA_LOAD_BUFFER_ADD_DATA 1 ESS_ASO_DATA_LOAD_BUFFER_SUBTRACT_DATA 2 ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_ALL_DATA 3 ESS_ASO_DATA_LOAD_BUFFER_OVERRIDE_INCREMENTAL_DATA 4
actionType - - commit or abort. values are: ESS_ASO_DATA_LOAD_BUFFER_COMMIT 1 ESS_ASO_DATA_LOAD_BUFFER_ABORT 2
termOption - - Values are: ESS_ASO_DATA_LOAD_INCR_TO_MAIN_SLICE 0x00000000 ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE 0x00000001 ESS_ASO_DATA_LOAD_IN_USE_BIT_MASK 0x00000003
Throws:
com.essbase.api.base.EssException
See Also:
startParallelDataload(String, String, String, boolean, String, String, String, int), setCommonBufferTermOptions(long, long, long), getStatusForDataload(), clearInstancesForDataload()

setCommonBufferTermOptions

void setCommonBufferTermOptions(long commitOption,
                                long actionType,
                                long termOption)
                                throws com.essbase.api.base.EssException
API for parallel ASO dataloads. This API will make one commit call for all the successful dataload buffers and one abort call for all dataload opertions that failed and dont have AbortOnError set. This API will override the LoadBufferTerm params specified for all the dataload instances during commit/abort. If this API is not invoked then the LoadBufferTerm will be invoked for each buffer separately using the params specified in the addInstanceForParallelDataload(String, int, String, boolean, long, long, String, String, long, long, long), which is the default behaviour. This call must be made after all the data sources are added using the addInstanceForParallelDataload() API. For performance reasons, EssLoadBufferTerm should always be called once by passing in the list of all bufferIds. This can be significantly faster than calling the function separately for each bufferId. If there is already a large amount of data in the database, and the ulOption is ESS_ASO_DATA_LOAD_INCR_TO_MAIN_SLICE, then the kernel must read all of the existing data in the database and merge it with the new data, then write a completely new cube to disk. If you've already got several gigabytes of data in the database, it will take a long time to read and write that data. If you have several load buffers to commit, you should commit them all at once so you won't have to re-write the old data multiple times. When you are using the ulOption ESS_ASO_DATA_LOAD_INCR_TO_NEW_SLICE, the performance benefit for making a single call to EssLoadBufferTerm instead of multiple calls is much less, since the new data is not merged with the old data - the new data is written to a different slice (you can think of it as a "sub-cube"), and the old data is not readat all. But there is still some small benefit to making a single call instead of multiple calls.
Parameters:
commitOption -
actionType -
termOption -
Throws:
com.essbase.api.base.EssException
See Also:
addInstanceForParallelDataload(String, int, String, boolean, long, long, String, String, long, long, long), startParallelDataload(String, String, String, boolean, String, String, String, int), getStatusForDataload(), clearInstancesForDataload()

clearInstancesForDataload

void clearInstancesForDataload()
                               throws com.essbase.api.base.EssException
API for parallel ASO dataloads. Removes all the instances that have been added and resets the flag which triggers the commonBufferTermOptions(). This should be called after the dataload is completed so that new parallel dataload operations do not accidentally use dataload sources from previous dataloads.
Throws:
com.essbase.api.base.EssException
See Also:
addInstanceForParallelDataload(String, int, String, boolean, long, long, String, String, long, long, long), setCommonBufferTermOptions(long, long, long), getStatusForDataload(), startParallelDataload(String, String, String, boolean, String, String, String, int)

getStatusForDataload

java.lang.String[][] getStatusForDataload()
                                          throws com.essbase.api.base.EssException
API for parallel ASO dataloads. Retrieves the status and error(if any) for each instance/buffer. This will return null if there are no instances added or if called after clearInstancesForDataload call. This should be called after the dataload is complete.
Returns:
String [][] - 3 columns for each instance/buffer as [BufferID], [Dataload Status], [Error message (if any)]. The values of Dataload status are: 0 - YET_TO_START_STATE, 1 - RUNNING_STATE, 2 - COMPLETED_STATE, 3 - FAILED_STATE.
Throws:
com.essbase.api.base.EssException
See Also:
addInstanceForParallelDataload(String, int, String, boolean, long, long, String, String, long, long, long), setCommonBufferTermOptions(long, long, long), startParallelDataload(String, String, String, boolean, String, String, String, int), clearInstancesForDataload()

startParallelDataload

java.lang.String[][] startParallelDataload(java.lang.String serverName,
                                           java.lang.String olapUserName,
                                           java.lang.String OlapPassword,
                                           boolean isPasswordToken,
                                           java.lang.String providerURL,
                                           java.lang.String appName,
                                           java.lang.String cubeName,
                                           int StartBufferId)
                                           throws com.essbase.api.base.EssException
API for parallel ASO dataloads. This will open different login sessions each on a different thread. For each session it will assign the BufferId from the StartBufferId and increment it by 1 for the next instance in the sequence that they were added. For each thread the following API are invoked - login, LoadBufferInit, BeginDataLoad, LoadBufferTerm and logoff. LoadBufferTerm is invoked individually for each thread if setCommonBufferTermOptions(long, long, long) is not called. The size for each buffer is split equally between the dataload instances added. Below is the sample code sequence IEssbase essbase = IEssbase.Home.create(IEssbase.JAPI_VERSION); essbase.addInstanceForParallelDataload("dataload", IEssOlapFileObject.TYPE_TEXT, "dataload1", false, 0, 0, null, null, 1, 1, 0); essbase.addInstanceForParallelDataload("loadFile", 0, null, false, 0, 0, "DBuser", "DBpassword", 1, 1, 0); essbase.setCommonBufferTermOptions(1, 1, 0); String[][] err = essbase.startParallelDataload("hostname", "system", "password", false, "Embedded", "ASOSamp", "Sample", 50); String [][] status = essbase.getStatusForDataload(); for (int i=0; i < status.length; i++) { System.out.println("Status for Buffer " + status[i][0] + " is " + status[i][1] + " " + status[i][2]); } for (int i=0; err != null && i < err.length; i++) { System.out.println(err[i][0]+ " " +err[i][1] + " " + err[i][2] + " " + err[i][3]); } essbase.clearInstancesForDataload();
Parameters:
serverName - - String, the Essbase server hostname
olapUserName - -String, the Essbase user
OlapPassword - -String, the Essbase user's password
isPasswordToken - -boolean true, if password param is token(if Essbase is in HSS mode)
providerURL - - String, the provider URL, i.e. "Embedded" if using JAPI in embedded mode else provider URL(http://host:port/aps/JAPI)
appName - - Stirng, the application name
cubeName - - String, the cube name
StartBufferId - - int, the starting buffer id. This will be used for the first data load instance and increment it for additional dataload instnace added.
Returns:
String[][] - Returns dataload errors, 4 columns for each error in the following format. [BufferId][Error_Number][Member Name][Error string containing the record]
Throws:
com.essbase.api.base.EssException
See Also:
addInstanceForParallelDataload(String, int, String, boolean, long, long, String, String, long, long, long), setCommonBufferTermOptions(long, long, long), getStatusForDataload(), clearInstancesForDataload()

Skip navigation links