|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssCluster
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.
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 |
---|
static final int PROP_NAME
static final int PROP_DESCRIPTION
static final int PROP_SERVICE_COMPONENT_NAMES
static final int s_countProperties
static final java.lang.String[] s_propNames
static final IEssValueAny.EEssDataType[] s_propDataTypes
static final IEssProperties.EEssPropertyMode[] s_propModes
static final int STATUS_BAD
static final int STATUS_GOOD
static final int STATUS_DISABLED
Method Detail |
---|
java.lang.String getName() throws com.essbase.api.base.EssException
getName
in interface IEssExtendedObject
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getDescription() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setDescription(java.lang.String desc) throws com.essbase.api.base.EssException
desc
- The cluster description.com.essbase.api.base.EssException
- if an error occurs.IEssCluster.EEssClusterType getType() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void setType(IEssCluster.EEssClusterType type) throws com.essbase.api.base.EssException
type
- - The cluster type.com.essbase.api.base.EssException
- if an error occurs.java.lang.String getServiceComponentNames() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an exception occurs.void setServiceComponentNames(java.lang.String compNames) throws com.essbase.api.base.EssException
compNames
- The service component names separated by semicolon. Eg: "localhost/Demo/Basic; localhost/Demo2/Basic".com.essbase.api.base.EssException
- if an exception occurs.void refreshPropertyValues() throws com.essbase.api.base.EssException
refreshPropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.void updatePropertyValues() throws com.essbase.api.base.EssException
updatePropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.void delete() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void disableComponent(java.lang.String componentName) throws com.essbase.api.base.EssException
componentName
- Stringcom.essbase.api.base.EssException
void enableComponent(java.lang.String componentName) throws com.essbase.api.base.EssException
componentName
- Stringcom.essbase.api.base.EssException
java.lang.String[][] getClusterStatus() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- - if an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |