Skip navigation links


com.essbase.api.domain
Interface IEssCluster

All Superinterfaces:
IEssBaseObject, IEssExtendedObject, IEssProperties

public interface IEssCluster
extends IEssExtendedObject, IEssProperties

The IEssCluster is a cluster definition. Since, Essbase Clustering operations make sense only in the 3-Tier Provider Services mode, all operations on this object are Deprecated in the "Embedded" Essbase-JAPI mode in 11.1.2.0.00 onwards. Clustering operations such as creating, deleting would not add/remove the cluster and its components to the Domain store and serve as dummy services in Emdedded mode only.

Version:
2.0, 08/24/2009
Author:
Srini Ranga

Nested Class Summary
static class IEssCluster.EEssClusterType
          The EEssClusterType class is an enumeration of server types.
static class IEssCluster.EEssLoadBalanceAlgorithm
          The EEssLoadBalanceAlgorithm class is an enumeration of load balance algorithms supported.

 

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

 

Field Summary
static int PROP_DESCRIPTION
           
static int PROP_NAME
           
static int PROP_SERVICE_COMPONENT_NAMES
           
static int s_countProperties
           
static IEssValueAny.EEssDataType[] s_propDataTypes
           
static IEssProperties.EEssPropertyMode[] s_propModes
           
static java.lang.String[] s_propNames
           
static int STATUS_BAD
           
static int STATUS_DISABLED
           
static int STATUS_GOOD
           

 

Method Summary
 void delete()
          Deletes this cluster.
 void disableComponent(java.lang.String componentName)
          Disable one component within this cluster.
 void enableComponent(java.lang.String componentName)
          Enable a disabled component within this cluster.
 java.lang.String[][] getClusterStatus()
          Fetches the cluster components status.
 java.lang.String getDescription()
          Gets the cluster description.
 java.lang.String getName()
          Gets the cluster name.
 java.lang.String getServiceComponentNames()
          Gets the service component names.
 IEssCluster.EEssClusterType getType()
          Gets the cluster type.
 void refreshPropertyValues()
          Refreshes the property values.
 void setDescription(java.lang.String desc)
          Sets the cluster description.
 void setServiceComponentNames(java.lang.String compNames)
          Sets the service component names.
 void setType(IEssCluster.EEssClusterType type)
          Sets the cluster type.
 void updatePropertyValues()
          Updates the property values.

 

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
See Also:
Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION
See Also:
Constant Field Values

PROP_SERVICE_COMPONENT_NAMES

static final int PROP_SERVICE_COMPONENT_NAMES
See Also:
Constant Field Values

s_countProperties

static final int s_countProperties
See Also:
Constant Field Values

s_propNames

static final java.lang.String[] s_propNames

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes

STATUS_BAD

static final int STATUS_BAD
See Also:
Constant Field Values

STATUS_GOOD

static final int STATUS_GOOD
See Also:
Constant Field Values

STATUS_DISABLED

static final int STATUS_DISABLED
See Also:
Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException
Gets the cluster name.
Specified by:
getName in interface IEssExtendedObject
Returns:
The cluster name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getDescription

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

setDescription

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

getType

IEssCluster.EEssClusterType getType()
                                    throws com.essbase.api.base.EssException
Gets the cluster type.
Returns:
The cluster type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

setType

void setType(IEssCluster.EEssClusterType type)
             throws com.essbase.api.base.EssException
Sets the cluster type. The change will become effective after you invoke updatePropertyValues().
Parameters:
type - - The cluster type.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getServiceComponentNames

java.lang.String getServiceComponentNames()
                                          throws com.essbase.api.base.EssException
Gets the service component names.
Returns:
The service component names separated by semicolon. Eg: "localhost/Demo/Basic; localhost/Demo2/Basic".
Throws:
com.essbase.api.base.EssException - if an exception occurs.

setServiceComponentNames

void setServiceComponentNames(java.lang.String compNames)
                              throws com.essbase.api.base.EssException
Sets the service component names. The change will become effective after you invoke updatePropertyValues().
Parameters:
compNames - The service component names separated by semicolon. Eg: "localhost/Demo/Basic; localhost/Demo2/Basic".
Throws:
com.essbase.api.base.EssException - if an exception occurs.

refreshPropertyValues

void refreshPropertyValues()
                           throws com.essbase.api.base.EssException
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
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
Deletes this cluster.
Throws:
com.essbase.api.base.EssException - if an error occurs.

disableComponent

void disableComponent(java.lang.String componentName)
                      throws com.essbase.api.base.EssException
Disable one component within this cluster.
Parameters:
componentName - String
Throws:
com.essbase.api.base.EssException

enableComponent

void enableComponent(java.lang.String componentName)
                     throws com.essbase.api.base.EssException
Enable a disabled component within this cluster.
Parameters:
componentName - String
Throws:
com.essbase.api.base.EssException

getClusterStatus

java.lang.String[][] getClusterStatus()
                                      throws com.essbase.api.base.EssException
Fetches the cluster components status. Status is returned as 2D String array having Component-State pair. State can have one of the following values. 0 - STATUS_BAD - Bad Component 1 - STATUS_GOOD - Good Component 2 - STATUS_DISABLED - Disabled Component Note : The returned by this API is meaningful only when used in 3-tier mode and not in Embedded mode.
Returns:
Component status as a key-value pair.
Throws:
com.essbase.api.base.EssException - - if an error occurs.

Skip navigation links