|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssbase represent client sessions with the Essbase.
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 |
changePassword(java.lang.String newPassword)
Changes the password for the signed on user. |
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()
Gets the token associated with CSS authentication. |
java.lang.String |
getDomainName()
Gets the name of the signed on Essbase domain name. |
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. |
IEssSession[] |
getSessions()
Gets information about sessions of all the users signed on to EDS server. |
java.lang.String |
getUserName()
Gets the name of the signed on user name. |
boolean |
isAssertionsEnabled()
Checks if assertions are enabled. |
boolean |
isDedicatedServerThreadNeeded()
Checks if this JAPI client needs dedicated server thread for the lifetime of the session. |
boolean |
isGlobalClientCachingEnabled()
Checks if global client caching is enabled. |
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)
Restores a timed out CSS token by resetting the timeout counter in the token, thereby extending the life of the token for future usage. |
void |
setAssertionsEnabled(boolean assertionsEnabled)
Sets if assertions are enabled. |
void |
setDedicatedServerThreadNeeded(boolean needDedicatedServerThread)
Sets if this JAPI client needs dedicated server thread for the life time of the session. |
void |
setGlobalClientCachingEnabled(boolean enableCaching)
Sets if global client caching is enabled. |
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 |
setSecureCommunicationEnabled(boolean secureCommunication)
Sets if secure communication (SSL) is enabled. |
void |
signOff()
Signs off the user from the Essbase domain. |
IEssDomain |
signOn(java.lang.String cssToken,
java.lang.String domainName,
java.lang.String edsUrl)
Signs on the user to the essbase domain. |
IEssDomain |
signOn(java.lang.String cssToken,
java.lang.String domainName,
java.lang.String prefEesSvrName,
IEssbase.EEssOrbPluginType orbPluginType,
int port)
Signs on the user to the essbase domain. |
IEssDomain |
signOn(java.lang.String userName,
java.lang.String password,
java.lang.String domainName,
java.lang.String eesUrl)
Signs on the user to the essbase domain. |
IEssDomain |
signOn(java.lang.String userName,
java.lang.String password,
java.lang.String domainName,
java.lang.String prefEesSvrName,
IEssbase.EEssOrbPluginType orbPluginType,
int port)
Signs on the user to the essbase domain. |
IEssOlapServer |
signOn(java.lang.String userName,
java.lang.String password,
java.lang.String domainName,
java.lang.String eesUrl,
java.lang.String olapServerName)
Signs on and connects to the specified olap server. |
Field Detail |
public static final java.lang.String JAPI_VERSION
Method Detail |
public java.lang.String getApiVersion() throws EssException
EssException
- if an error occurs.public java.lang.String getApiVersionDetail() throws EssException
EssException
- if an error occurs.public java.lang.String getUserName() throws EssException
EssException
- if an error occurs.public java.lang.String getDomainName() throws EssException
EssException
- if an error occurs.public boolean isGlobalClientCachingEnabled() throws EssException
EssException
- if an error occurs.public void setGlobalClientCachingEnabled(boolean enableCaching) throws EssException
enableCaching
- true if global caching is to be enabled.
EssException
- if an error occurs.public boolean isSecureCommunicationEnabled() throws EssException
EssException
- if an error occurs.public void setSecureCommunicationEnabled(boolean secureCommunication) throws EssException
secureCommunication
- true if secure communication is to be enabled.
EssException
- if an error occurs.public int getNetRetryCount() throws EssException
EssException
- if an error occurs.public void setNetRetryCount(int netRetryCnt) throws EssException
netRetryCnt
- The count of maximum retry attempts.
EssException
- if an error occurs.public int getNetRetryInterval() throws EssException
EssException
- if an error occurs.public void setNetRetryInterval(int netRetryInvl) throws EssException
netRetryInvl
- The interval between retry attempts.
EssException
- if an error occurs.public boolean isDedicatedServerThreadNeeded() throws EssException
EssException
- if an error occurs.public void setDedicatedServerThreadNeeded(boolean needDedicatedServerThread) throws EssException
needDedicatedServerThread
- true to let the server know to dedicate
a thread for this JAPI client.
EssException
- if an error occurs.public boolean isAssertionsEnabled() throws EssException
EssException
- if an error occurs.public void setAssertionsEnabled(boolean assertionsEnabled) throws EssException
assertionsEnabled
- true if assertions are enabled.
EssException
- if an error occurs.public IEssLocationInfo[] getLocationInfoForRunningEnterpriseServers() throws EssException
EssException
- if an error occurs.public IEssDomain signOn(java.lang.String userName, java.lang.String password, java.lang.String domainName, java.lang.String prefEesSvrName, IEssbase.EEssOrbPluginType orbPluginType, int port) throws EssException
userName
- The user name.password
- The user password.domainName
- The hierachical name of the domain.prefEesSvrName
- The preferred essbase enterprise 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, EJB or TCPIP. Just
pass 0 for other types.
EssException
- if an error occurs.public IEssDomain signOn(java.lang.String cssToken, java.lang.String domainName, java.lang.String prefEesSvrName, IEssbase.EEssOrbPluginType orbPluginType, int port) throws EssException
cssToken
- The token from prior CSS authentication.domainName
- The hierachical name of the domain.prefEesSvrName
- The preferred essbase enterprise 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, EJB or TCPIP. Just
pass 0 for other types.
EssException
- if an error occurs.public IEssDomain signOn(java.lang.String userName, java.lang.String password, java.lang.String domainName, java.lang.String eesUrl) throws EssException
userName
- The user name.password
- The user password.domainName
- The hierachical name of the domain.eesUrl
- The url of the essbase enterprise server servlet or tcpip
server. For tcpip server pass for e.g tcpip://localhost:5001
EssException
- if an error occurs. Error codes:
IEssException.ERROR_INVALID_USER_OR_PASSWORD.public IEssDomain signOn(java.lang.String cssToken, java.lang.String domainName, java.lang.String edsUrl) throws EssException
cssToken
- The token from prior CSS authentication.domainName
- The hierachical name of the domain.edsUrl
- The url of the essbase deployment server servlet or tcpip
server. For tcpip server pass for e.g tcpip://localhost:5001
EssException
- if an error occurs.public IEssOlapServer signOn(java.lang.String userName, java.lang.String password, java.lang.String domainName, java.lang.String eesUrl, java.lang.String olapServerName) throws EssException
password
- The password.domainName
- The EDS domain name.olapServerName
- The host name where the analytic server is running.
EssException
- if an error occurs.public java.lang.String getCssToken() throws EssException
EssException
public java.lang.String restoreCssToken(java.lang.String token) throws EssException
token
- The timed out token.
EssException
public IEssSession[] getSessions() throws EssException
EssException
- if an error occurs.public void signOff() throws EssException
EssException
- if an error occurs.public boolean isSignedOn() throws EssException
EssException
- if an error occurs.public IEssDomain getRootDomain() throws EssException
EssException
- if an error occurs.public void changePassword(java.lang.String newPassword) throws EssException
newPassword
- The new password.
EssException
- if an error occurs.public IEssValueAny createIEssValueAny() throws EssException
EssException
- if an error occurs.public IEssCollection createIEssCollection() throws EssException
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |