|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssOlapServer interface is the OLAP server.
Nested Class Summary | |
static interface |
IEssOlapServer.IEssOlapConnectionInfo
The IEssOlapConnectionInfo interface provides OLAP agent/server connection information. |
Nested classes inherited from class com.essbase.api.domain.IEssServer |
IEssServer.EEssServerType |
Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
Nested classes inherited from class com.essbase.api.domain.IEssAppComponent |
IEssAppComponent.EEssAppComponentType |
Field Summary | |
static int |
PROP_DESCRIPTION
|
static int |
PROP_NAME
|
static int |
PROP_REMOTE_START_COMMAND
|
static int |
s_countProperties
|
static IEssValueAny.EEssDataType[] |
s_propDataTypes
|
static IEssProperties.EEssPropertyMode[] |
s_propModes
|
static java.lang.String[] |
s_propNames
|
Method Summary | |
void |
clearActive()
Clears the current active application and database for this instance of the IEssOLAPServer object. |
void |
connect()
Opens a connection to the olap agent. |
void |
connect(boolean useEdsAtOlapSvrNode)
Opens a connection to the olap agent. |
void |
connect(boolean useConnPool,
boolean connPerOp)
Opens a connection to the olap agent. |
void |
convertApplicationToUnicode(java.lang.String appName)
Converts application to unicode. |
void |
copyOlapFileObject(java.lang.String appName,
java.lang.String cubeName,
int objType,
java.lang.String objName,
java.lang.String destAppName,
java.lang.String destCubeName,
java.lang.String destObjName)
Copies an olap file object. |
void |
copyOlapFileObjectFromServer(java.lang.String appName,
java.lang.String cubeName,
int objType,
java.lang.String objName,
java.lang.String clientFileName,
boolean lock)
Copies an object from the olap server to a client file and optionally locks the server object to prevent updates by others. |
void |
copyOlapFileObjectToServer(java.lang.String appName,
java.lang.String cubeName,
int objType,
java.lang.String objName,
java.lang.String clientFileName,
boolean unlock)
Copies an object from a client file to the olap server, and optionally unlocks the server object to allow updates by others. |
IEssOlapApplication |
createApplication(java.lang.String appName)
Creates a new application and starts it. |
IEssOlapApplication |
createApplication(java.lang.String appName,
short storageType)
Creates a new application with the given storage type and starts it. |
IEssOlapApplication |
createApplication(java.lang.String appName,
java.lang.String appType)
Creates a new application and starts it. |
IEssOlapApplication |
createApplication(java.lang.String appName,
java.lang.String desc,
int maxLroFileSize,
boolean loadable,
boolean autoLoad,
boolean allowCommands,
boolean allowConnects,
boolean allowUpdates,
boolean enableSecurity,
int lockTimeOutPeriod,
IEssCube.EEssCubeAccess minCubeAccess)
Creates a new application setting all the specified properties and starts it. |
void |
createOlapFileObject(java.lang.String appName,
java.lang.String cubeName,
int objType,
java.lang.String objName)
Creates a new olap file object. |
void |
delete()
Deletes this server from the domain. |
void |
deleteLogFile()
Deletes the agent log file (essbase.log). |
void |
deleteOlapFileObject(java.lang.String appName,
java.lang.String cubeName,
int objType,
java.lang.String objName)
Delte an existing olap file object. |
void |
disconnect()
Closes the connection to the olap agent. |
java.lang.String[] |
getActive()
Gets the names of the current active application and cube for this instance of the IEssOlapServer object. |
IEssOlapApplication |
getApplication(java.lang.String appName)
Gets the specified application. |
IEssIterator |
getApplications()
Gets the list of applications which are accessible to the caller. |
IEssIterator |
getConnections()
Gets the list of user connections to the olap agent/server. |
java.lang.String |
getDescription()
Gets the olap server description. |
int |
getLogSize(boolean agentLog,
java.lang.String appName)
Gets the size of the Agent log file (ESSBASE.LOG), or of the Server log file (APPNAME.LOG). |
java.lang.String |
getName()
Gets the olap server name/IP address. |
IEssOlapFileObject |
getOlapFileObject(java.lang.String appName,
java.lang.String cubeName,
int objType,
java.lang.String objName)
Gets information about a specified olap store file object. |
IEssIterator |
getOlapFileObjects(java.lang.String appName,
java.lang.String cubeName,
int objType)
Gets all the olap store file objects of the types specified. |
java.lang.String |
getOlapServerVersion()
Gets the full version number of the connected Essbase olap server, in the form release.version.revision. |
IEssIterator |
getRequests(java.lang.String userName,
java.lang.String appName,
java.lang.String cubeName)
Gets all the requests at the olap server for the matching userName, appName or cubeName. |
java.lang.String |
getStartCommand()
Gets the command to start this olap server. |
boolean |
isConnected()
Checks if a connection is open to the olap agent. |
boolean |
isUnicodeEnabled()
Checks if server is unicode enabled. |
void |
killLastRequest()
Kills the last request if it is still running. |
void |
lockOlapFileObject(java.lang.String appName,
java.lang.String cubeName,
int objType,
java.lang.String objName)
Locks an object on the server to prevent other users from updating it. |
void |
refreshPropertyValues()
Refreshes the property values. |
void |
renameOlapFileObject(java.lang.String appName,
java.lang.String cubeName,
int objType,
java.lang.String objName,
java.lang.String newObjName)
Renames an existing olap file object. |
void |
setActive(java.lang.String appName,
java.lang.String cubeName)
Sets the active application and cube for this instance of the IEssOlapServer object. |
void |
setDescription(java.lang.String desc)
Sets the olap server description. |
void |
setStartCommand(java.lang.String startCmd)
Sets the command to start this olap server. |
void |
setUnicodeEnabled(boolean enabled)
Sets the server unicode enabled. |
void |
start()
Starts the OLAP agent if it is not already running. |
void |
start(java.lang.String osUserName,
java.lang.String osUserPassword,
java.lang.String osDomainName)
Starts the OLAP agent if it is not already running. |
void |
stop()
Stops the Essbase OLAP Agent. |
void |
unlockOlapFileObject(java.lang.String appName,
java.lang.String cubeName,
int objType,
java.lang.String objName)
Unlocks a locked object on the server. |
void |
updatePropertyValues()
Updates the property values. |
void |
writeToLogFile(boolean agentLog,
java.lang.String message)
Writes a message to the agent log file (essbase.log) or to the server log file (appname.log). |
Methods inherited from interface com.essbase.api.domain.IEssServer |
getServerType |
Methods inherited from interface com.essbase.api.base.IEssExtendedObject |
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled |
Methods inherited from interface com.essbase.api.base.IEssProperties |
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny |
Methods inherited from interface com.essbase.api.domain.IEssAppComponent |
getAppComponentType |
Methods inherited from interface com.essbase.api.datasource.IEssSubstitutionVariables |
createSubstitutionVariable, deleteSubstitutionVariable, getSubstitutionVariables, getSubstitutionVariableValue |
Field Detail |
public static final int PROP_NAME
public static final int PROP_DESCRIPTION
public static final int PROP_REMOTE_START_COMMAND
public static final int s_countProperties
public static final java.lang.String[] s_propNames
public static final IEssValueAny.EEssDataType[] s_propDataTypes
public static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
public java.lang.String getName() throws EssException
getName
in interface IEssExtendedObject
EssException
- if an error occurs.public java.lang.String getDescription() throws EssException
EssException
- if an error occurs.public void setDescription(java.lang.String desc) throws EssException
desc
- The olap server description.
EssException
- if an error occurs.public java.lang.String getStartCommand() throws EssException
EssException
- if an error occurs.public void setStartCommand(java.lang.String startCmd) throws EssException
startCmd
- The startup command.
EssException
- if an error occurs.public void refreshPropertyValues() throws EssException
refreshPropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void updatePropertyValues() throws EssException
updatePropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void connect() throws EssException
EssException
- if an error occurs.public void connect(boolean useConnPool, boolean connPerOp) throws EssException
useConnPool
- true to use connection pool if available.connPerOp
- true for connection per operation. false for connection
per session. NOTE: Only false is supported currently, and true is for
future use.
EssException
- if an error occurs.public void connect(boolean useEdsAtOlapSvrNode) throws EssException
useEdsAtOlapSvrNode
- If true, the deployment server at the node
where this olap server resides is used to traffic the requests between the
JAPI client and the olap server. If false, the enterprise server that
authenticated the user is used to traffic the requests.
EssException
- if an error occurs.public void disconnect() throws EssException
EssException
- if an error occurs.public boolean isConnected() throws EssException
EssException
- if an error occurs.public java.lang.String getOlapServerVersion() throws EssException
EssException
- if an error occurs.public IEssIterator getApplications() throws EssException
EssException
- if an error occurs.public IEssOlapApplication getApplication(java.lang.String appName) throws EssException
appName
- The application name.
EssException
- if an error occurs.public IEssOlapApplication createApplication(java.lang.String appName) throws EssException
appName
- The application name.
EssException
- if an error occurs.public IEssOlapApplication createApplication(java.lang.String appName, java.lang.String appType) throws EssException
appName
- The application name.appType
- The application type ("native" or "utf8").
EssException
- if an error occurs.public IEssOlapApplication createApplication(java.lang.String appName, java.lang.String desc, int maxLroFileSize, boolean loadable, boolean autoLoad, boolean allowCommands, boolean allowConnects, boolean allowUpdates, boolean enableSecurity, int lockTimeOutPeriod, IEssCube.EEssCubeAccess minCubeAccess) throws EssException
desc
- The description.maxLroFileSize
- The maximum file size (in bytes).loadable
- true if application is loadable.autoLoad
- true if the application will be automatically loaded.allowCommands
- true if the application is accepting user commands.allowConnects
- true if users can connect.allowUpdates
- true if the application is accepting user update commands.enableSecurity
- true security is enabled.lockTimeOutPeriod
- The time out period (in minutes).minCubeAccess
- The minimum cube access.
EssException
- if an error occurs.public IEssOlapApplication createApplication(java.lang.String appName, short storageType) throws EssException
appName
- The application name.storageType
- The application storagetype - Only valid value in this version is 4
which creates an ASO (Aggregate Storage Option) type application.
EssException
- if an error occurs.public void convertApplicationToUnicode(java.lang.String appName) throws EssException
appName
- The application name.
EssException
- if an error occurs.public void setUnicodeEnabled(boolean enabled) throws EssException
enabled
- true to unicode enable the server.
EssException
- if an error occurs.public boolean isUnicodeEnabled() throws EssException
EssException
- if an error occurs.public IEssIterator getConnections() throws EssException
EssException
- if an error occurs.public java.lang.String[] getActive() throws EssException
EssException
- if an error occurs.public void setActive(java.lang.String appName, java.lang.String cubeName) throws EssException
appName
- The application name.cubeName
- The cube name.
EssException
- if an error occurs.public void clearActive() throws EssException
EssException
- if an error occurs.public void start() throws EssException
EssException
- if an error occurs.public void start(java.lang.String osUserName, java.lang.String osUserPassword, java.lang.String osDomainName) throws EssException
osUserName
- The OS user name on the destination host.osUserPassword
- The OS user password.osDomainName
- The OS domain name.
EssException
- if an error occurs.public void stop() throws EssException
EssException
- if an error occurs.public int getLogSize(boolean agentLog, java.lang.String appName) throws EssException
agentLog
- If true, the size of the Agent log file (ESSBASE.LOG) is
returned. If false, the size of the Server log file (APPNAME.LOG) is
returned.appName
- The application name.
EssException
- if an error occurs.public void writeToLogFile(boolean agentLog, java.lang.String message) throws EssException
agentLog
- If true, message is written to the agent log file,
essbase.log. If false, message is written to the server log file,
appname.log. If false, make sure that an application is active by
invoking setActive(), before invoking this method.message
- The message to be logged to the agent log file
(essbase.log), or to the server log file (appname.log).
EssException
- if an error occurs.public void deleteLogFile() throws EssException
EssException
- if an error occurs.public IEssIterator getRequests(java.lang.String userName, java.lang.String appName, java.lang.String cubeName) throws EssException
userName
- The user name filter. If null, all users are considered.appName
- The application name filter. If null, all applications
are considered.cubeName
- The cube name filter. If null, all cubes are considered.
EssException
- if an error occurs.public IEssIterator getOlapFileObjects(java.lang.String appName, java.lang.String cubeName, int objType) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object types. Values from IEssOlapFileObject.TYPE_*.
EssException
- if an error occurs.public IEssOlapFileObject getOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void copyOlapFileObjectFromServer(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName, java.lang.String clientFileName, boolean lock) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.clientFileName
- The full path of destination file in the client.lock
- Flag to control object locking. If true, the server object
is locked to prevent updates by other users.
EssException
- if an error occurs.public void copyOlapFileObjectToServer(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName, java.lang.String clientFileName, boolean unlock) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.clientFileName
- The full path of source file in the client.
EssException
- if an error occurs.public void lockOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void unlockOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void createOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void deleteOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void renameOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName, java.lang.String newObjName) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.
EssException
- if an error occurs.public void copyOlapFileObject(java.lang.String appName, java.lang.String cubeName, int objType, java.lang.String objName, java.lang.String destAppName, java.lang.String destCubeName, java.lang.String destObjName) throws EssException
appName
- The application name.cubeName
- The cube name. null to use the application directory.objType
- The object type. Value from IEssOlapFileObject.TYPE_*.objName
- The object name.destAppName
- The destination application name.destCubeName
- The destination cube name.destObjName
- The destination object name.
EssException
- if an error occurs.public void killLastRequest() throws EssException
EssException
- if an error occurs.public void delete() throws EssException
delete
in interface IEssServer
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |