|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
The IEssEnterpriseServer is the Essbase Enterprise server.
| Nested Class Summary |
| Nested classes inherited from class com.essbase.api.domain.IEssServer |
IEssServer.EEssServerType |
| Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
| Field Summary | |
static int |
PROP_DESCRIPTION
|
static int |
PROP_ENABLED_CLUSTER_NAMES
|
static int |
PROP_ENABLED_CONNECTION_POOL_NAMES
|
static int |
PROP_NAME
|
static int |
PROP_OUTLINE_CACHE_ENABLED
|
static int |
PROP_OUTLINE_CACHE_MAX_IDLE_TIME
|
static int |
PROP_OUTLINE_CACHE_SOURCES
|
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 |
closeAllClustersAndConnectionPools()
Closes all the opened clusters and connection pools. |
void |
delete()
Deletes/Unregisters this server from the domain. |
java.lang.String |
getDescription()
Gets the enterprise server description. |
java.lang.String |
getEnabledClusterNames()
Gets the enabled cluster names. |
java.lang.String |
getEnabledConnectionPoolNames()
Gets the enabled connection pool names. |
java.lang.String |
getName()
Gets the enterprise server name/ip address. |
int |
getOutlineCacheMaxIdleTime()
Gets the maximum idle time (in minutes) after which the cache will be cleared for each cube source. |
java.lang.String |
getOutlineCacheSources()
Gets outline cache cube sources, each separated by a semicolon. |
java.lang.String |
getStartCommand()
Gets the command to start this enterprise server. |
boolean |
isOutlineCacheEnabled()
Checks if outline caching is enabled. |
void |
openAllClustersAndConnectionPools()
Opens (sets up) all the enabled clusters and connection pools. |
void |
refreshPropertyValues()
Refreshes the property values. |
void |
setDescription(java.lang.String desc)
Sets the enterprise server description. |
void |
setEnabledClusterNames(java.lang.String clusterNames)
Sets the enabled cluster names. |
void |
setEnabledConnectionPoolNames(java.lang.String poolNames)
Sets the enabled connection pool names. |
void |
setOutlineCacheEnabled(boolean otlCacheEnabled)
Sets if outline caching is enabled. |
void |
setOutlineCacheMaxIdleTime(int maxIdleTime)
Sets the maximum idle time (in minutes) after which the cache will be cleared for each cube source. |
void |
setOutlineCacheSources(java.lang.String otlCacheSources)
Sets outline cache cube sources, each separated by a semicolon. |
void |
setStartCommand(java.lang.String startCmd)
Sets the command to start this enterprise server. |
void |
start()
Starts the enterprise server if it is not already running. |
void |
start(java.lang.String osUserName,
java.lang.String osUserPassword,
java.lang.String osDomainName)
Starts the enterprise server if it is not already running. |
void |
stop()
Stops the enterprise server if it is running. |
void |
updatePropertyValues()
Updates the property values. |
| 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 |
| 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 PROP_ENABLED_CLUSTER_NAMES
public static final int PROP_ENABLED_CONNECTION_POOL_NAMES
public static final int PROP_OUTLINE_CACHE_ENABLED
public static final int PROP_OUTLINE_CACHE_SOURCES
public static final int PROP_OUTLINE_CACHE_MAX_IDLE_TIME
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 IEssExtendedObjectEssException - 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 enterprise 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 java.lang.String getEnabledClusterNames()
throws EssException
EssException - if an error occurs.
public void setEnabledClusterNames(java.lang.String clusterNames)
throws EssException
clusterNames - The enabled cluster names, each separated by a comma.
Eg: "demoBasicCluster,sampleBasicCluster".
EssException - if an error occurs.
public java.lang.String getEnabledConnectionPoolNames()
throws EssException
EssException - if an error occurs.
public void setEnabledConnectionPoolNames(java.lang.String poolNames)
throws EssException
EssException - if an error occurs.
public boolean isOutlineCacheEnabled()
throws EssException
EssException - if an error occurs.
public void setOutlineCacheEnabled(boolean otlCacheEnabled)
throws EssException
otlCacheEnabled - true to enable outline caching.
EssException - if an error occurs.
public java.lang.String getOutlineCacheSources()
throws EssException
EssException - if an error occurs.
public void setOutlineCacheSources(java.lang.String otlCacheSources)
throws EssException
otlCacheSources - The ouline cache cube sources.
Eg: "localhost/sample/basic; localhost/demo/basic".
EssException - if an error occurs.
public int getOutlineCacheMaxIdleTime()
throws EssException
EssException - if an error occurs.
public void setOutlineCacheMaxIdleTime(int maxIdleTime)
throws EssException
maxIdleTime - The maximum idle time (in minutes) for clearing cache.
This value cannot be less than 1 minute.
EssException - if an error occurs.
public void refreshPropertyValues()
throws EssException
refreshPropertyValues in interface IEssPropertiesEssException - if an error occurs.
public void updatePropertyValues()
throws EssException
updatePropertyValues in interface IEssPropertiesEssException - if an error occurs.
public void delete()
throws EssException
delete in interface IEssServerEssException - 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 void openAllClustersAndConnectionPools()
throws EssException
EssException - if an error occurs.
public void closeAllClustersAndConnectionPools()
throws EssException
EssException - if an error occurs.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||