Skip navigation links


com.essbase.api.domain
Interface IEssEnterpriseServer

All Superinterfaces:
IEssBaseObject, IEssExtendedObject, IEssProperties, IEssServer

Deprecated. This interface has been deprecated as it represents the EDS/AHAS server.

public interface IEssEnterpriseServer
extends IEssServer, IEssExtendedObject, IEssProperties

The IEssEnterpriseServer is the Essbase Enterprise server.

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

Nested Class Summary

 

Nested classes/interfaces inherited from interface com.essbase.api.domain.IEssServer
IEssServer.EEssServerType

 

Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties
IEssProperties.EEssPropertyMode

 

Field Summary
static int PROP_DESCRIPTION
          Deprecated.  
static int PROP_ENABLED_CLUSTER_NAMES
          Deprecated.  
static int PROP_ENABLED_CONNECTION_POOL_NAMES
          Deprecated.  
static int PROP_NAME
          Deprecated.  
static int PROP_OUTLINE_CACHE_ENABLED
          Deprecated.  
static int PROP_OUTLINE_CACHE_MAX_IDLE_TIME
          Deprecated.  
static int PROP_OUTLINE_CACHE_SOURCES
          Deprecated.  
static int s_countProperties
          Deprecated.  
static IEssValueAny.EEssDataType[] s_propDataTypes
          Deprecated.  
static IEssProperties.EEssPropertyMode[] s_propModes
          Deprecated.  
static java.lang.String[] s_propNames
          Deprecated.  

 

Method Summary
 void closeAllClustersAndConnectionPools()
          Deprecated. This functionality has been deprecated.
 void delete()
          Deprecated. Deletes/Unregisters this server from the domain.
 java.lang.String getDescription()
          Deprecated. Gets the enterprise server description.
 java.lang.String getEnabledClusterNames()
          Deprecated. Gets the enabled cluster names.
 java.lang.String getEnabledConnectionPoolNames()
          Deprecated. This functionality has been deprecated.
 java.lang.String getName()
          Deprecated. Gets the enterprise server name/ip address.
 int getOutlineCacheMaxIdleTime()
          Deprecated. This functionality has been deprecated.
 java.lang.String getOutlineCacheSources()
          Deprecated. This functionality has been deprecated.
 java.lang.String getStartCommand()
          Deprecated. This functionality has been deprecated.
 boolean isOutlineCacheEnabled()
          Deprecated. This functionality has been deprecated.
 void openAllClustersAndConnectionPools()
          Deprecated. This functionality has been deprecated.
 void refreshPropertyValues()
          Deprecated. Refreshes the property values.
 void setDescription(java.lang.String desc)
          Deprecated. Sets the enterprise server description.
 void setEnabledClusterNames(java.lang.String clusterNames)
          Deprecated. Sets the enabled cluster names.
 void setEnabledConnectionPoolNames(java.lang.String connPoolNames)
          Deprecated. This functionality has been deprecated.
 void setOutlineCacheEnabled(boolean otlCacheEnabled)
          Deprecated. This functionality has been deprecated.
 void setOutlineCacheMaxIdleTime(int maxIdleTime)
          Deprecated. This functionality has been deprecated.
 void setOutlineCacheSources(java.lang.String otlCacheSources)
          Deprecated. This functionality has been deprecated.
 void setStartCommand(java.lang.String startCmd)
          Deprecated. This functionality has been deprecated.
 void start()
          Deprecated. This functionality has been deprecated.
 void start(java.lang.String osUserName, java.lang.String osUserPassword, java.lang.String osDomainName)
          Deprecated. This functionality has been deprecated.
 void stop()
          Deprecated. This functionality has been deprecated.
 void updatePropertyValues()
          Deprecated. 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

PROP_NAME

static final int PROP_NAME
Deprecated. 
See Also:
Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION
Deprecated. 
See Also:
Constant Field Values

PROP_ENABLED_CLUSTER_NAMES

static final int PROP_ENABLED_CLUSTER_NAMES
Deprecated. 
See Also:
Constant Field Values

PROP_ENABLED_CONNECTION_POOL_NAMES

static final int PROP_ENABLED_CONNECTION_POOL_NAMES
Deprecated. 
See Also:
Constant Field Values

PROP_OUTLINE_CACHE_ENABLED

static final int PROP_OUTLINE_CACHE_ENABLED
Deprecated. 
See Also:
Constant Field Values

PROP_OUTLINE_CACHE_SOURCES

static final int PROP_OUTLINE_CACHE_SOURCES
Deprecated. 
See Also:
Constant Field Values

PROP_OUTLINE_CACHE_MAX_IDLE_TIME

static final int PROP_OUTLINE_CACHE_MAX_IDLE_TIME
Deprecated. 
See Also:
Constant Field Values

s_countProperties

static final int s_countProperties
Deprecated. 
See Also:
Constant Field Values

s_propNames

static final java.lang.String[] s_propNames
Deprecated. 

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes
Deprecated. 

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes
Deprecated. 

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException
Deprecated. 
Gets the enterprise server name/ip address.
Specified by:
getName in interface IEssExtendedObject
Returns:
The EES Server name/IP address.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDescription

java.lang.String getDescription()
                                throws com.essbase.api.base.EssException
Deprecated. 
Gets the enterprise server description.
Returns:
The enterprise server description.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setDescription

void setDescription(java.lang.String desc)
                    throws com.essbase.api.base.EssException
Deprecated. 
Sets the enterprise server description. The change will become effective after you invoke updatePropertyValues().
Parameters:
desc - The enterprise server description.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getStartCommand

java.lang.String getStartCommand()
                                 throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the command to start this enterprise server.
Returns:
The startup command.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setStartCommand

void setStartCommand(java.lang.String startCmd)
                     throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Sets the command to start this enterprise server. The change will become effective after you invoke updatePropertyValues().
Parameters:
startCmd - The startup command.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getEnabledClusterNames

java.lang.String getEnabledClusterNames()
                                        throws com.essbase.api.base.EssException
Deprecated. 
Gets the enabled cluster names.
Returns:
The enabled cluster names, each separated by a comma. Eg: "demoBasicCluster,sampleBasicCluster".
Throws:
com.essbase.api.base.EssException - if an error occurs.

setEnabledClusterNames

void setEnabledClusterNames(java.lang.String clusterNames)
                            throws com.essbase.api.base.EssException
Deprecated. 
Sets the enabled cluster names. Make sure that the clusters are already created using IEssDomain.createCluster(). The change will become effective after you invoke updatePropertyValues().
Parameters:
clusterNames - The enabled cluster names, each separated by a comma. Eg: "demoBasicCluster,sampleBasicCluster".
Throws:
com.essbase.api.base.EssException - if an error occurs.

getEnabledConnectionPoolNames

java.lang.String getEnabledConnectionPoolNames()
                                               throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the enabled connection pool names.
Returns:
The enabled connection pool names, each separated by a comma. Eg: "demoBasicPool,sampleBasicPool".
Throws:
com.essbase.api.base.EssException - if an error occurs.

setEnabledConnectionPoolNames

void setEnabledConnectionPoolNames(java.lang.String connPoolNames)
                                   throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Sets the enabled connection pool names. Make sure that the connectiopn pools are already created using IEssDomain.createConnectionPool(). The change will become effective after you invoke updatePropertyValues().
Parameters:
connPoolNames - The enabled connection pool names, each separated by a comma. Eg: "demoBasicPool,sampleBasicPool".
Throws:
com.essbase.api.base.EssException - if an error occurs.

isOutlineCacheEnabled

boolean isOutlineCacheEnabled()
                              throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Checks if outline caching is enabled. (FOR FUTURE USE)
Returns:
true if outline caching is enabled.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setOutlineCacheEnabled

void setOutlineCacheEnabled(boolean otlCacheEnabled)
                            throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Sets if outline caching is enabled. (FOR FUTURE USE)
Parameters:
otlCacheEnabled - true to enable outline caching.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getOutlineCacheSources

java.lang.String getOutlineCacheSources()
                                        throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets outline cache cube sources, each separated by a semicolon. (FOR FUTURE USE)
Returns:
The ouline cache cube sources. Eg: "localhost/sample/basic; localhost/demo/basic".
Throws:
com.essbase.api.base.EssException - if an error occurs.

setOutlineCacheSources

void setOutlineCacheSources(java.lang.String otlCacheSources)
                            throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Sets outline cache cube sources, each separated by a semicolon. (FOR FUTURE USE)
Parameters:
otlCacheSources - The ouline cache cube sources. Eg: "localhost/sample/basic; localhost/demo/basic".
Throws:
com.essbase.api.base.EssException - if an error occurs.

getOutlineCacheMaxIdleTime

int getOutlineCacheMaxIdleTime()
                               throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Gets the maximum idle time (in minutes) after which the cache will be cleared for each cube source. (FOR FUTURE USE)
Returns:
The maximum idle time (in minutes) for clearing cache.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setOutlineCacheMaxIdleTime

void setOutlineCacheMaxIdleTime(int maxIdleTime)
                                throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Sets the maximum idle time (in minutes) after which the cache will be cleared for each cube source. (FOR FUTURE USE)
Parameters:
maxIdleTime - The maximum idle time (in minutes) for clearing cache. This value cannot be less than 1 minute.
Throws:
com.essbase.api.base.EssException - if an error occurs.

refreshPropertyValues

void refreshPropertyValues()
                           throws com.essbase.api.base.EssException
Deprecated. 
Refreshes the property values. The JAPI cache for this object is refreshed with the latest values from the server, so that all the getXXX() methods will return the latest values.
Specified by:
refreshPropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.EssException - if an error occurs.

updatePropertyValues

void updatePropertyValues()
                          throws com.essbase.api.base.EssException
Deprecated. 
Updates the property values. The changes made to this object via setXXX() methods will become effective only after you invoke updatePropertyValues().
Specified by:
updatePropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.EssException - if an error occurs.

delete

void delete()
            throws com.essbase.api.base.EssException
Deprecated. 
Deletes/Unregisters this server from the domain.
Specified by:
delete in interface IEssServer
Throws:
com.essbase.api.base.EssException - if an error occurs.

start

void start()
           throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Starts the enterprise server if it is not already running.
Throws:
com.essbase.api.base.EssException - if an error occurs.

start

void start(java.lang.String osUserName,
           java.lang.String osUserPassword,
           java.lang.String osDomainName)
           throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Starts the enterprise server if it is not already running.
Parameters:
osUserName - The OS user name on the destination host.
osUserPassword - The OS user password.
osDomainName - The OS domain name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

stop

void stop()
          throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Stops the enterprise server if it is running.
Throws:
com.essbase.api.base.EssException - if an error occurs.

openAllClustersAndConnectionPools

void openAllClustersAndConnectionPools()
                                       throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Opens (sets up) all the enabled clusters and connection pools.
Throws:
com.essbase.api.base.EssException - if an error occurs.

closeAllClustersAndConnectionPools

void closeAllClustersAndConnectionPools()
                                        throws com.essbase.api.base.EssException
Deprecated. This functionality has been deprecated.
Closes all the opened clusters and connection pools.
Throws:
com.essbase.api.base.EssException - if an error occurs.

Skip navigation links