|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
The IEssConnectionPool is a connection pool definition.
| Nested Class Summary | |
static class |
IEssConnectionPool.EEssConnectionPoolType
The EEssConnectionPoolType class is an enumeration of server types. |
| Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
| Field Summary | |
static int |
PROP_ALLOW_EVERYONE
|
static int |
PROP_ALLOWED_GROUPS
|
static int |
PROP_ALLOWED_USERS
|
static int |
PROP_CAPACITY_INCREMENT
|
static int |
PROP_DESCRIPTION
|
static int |
PROP_INITIAL_CAPACITY
|
static int |
PROP_MAXIMUM_CAPACITY
|
static int |
PROP_NAME
|
static int |
PROP_PASSWORD
|
static int |
PROP_SERVICE_COMPONENT_IS_CLUSTER
|
static int |
PROP_SERVICE_COMPONENT_NAME
|
static int |
PROP_USER_NAME
|
static int |
s_countProperties
|
static IEssValueAny.EEssDataType[] |
s_propDataTypes
|
static IEssProperties.EEssPropertyMode[] |
s_propModes
|
static java.lang.String[] |
s_propNames
|
| Method Summary | |
void |
delete()
Deletes this connection pool. |
java.lang.String |
getAllowedGroupNames()
Gets the allowed group names. |
java.lang.String |
getAllowedUserNames()
Gets the allowed user names. |
int |
getCapacityIncrement()
Gets the capacity increment. |
java.lang.String |
getDescription()
Gets the connection pool description. |
int |
getInitialCapacity()
Gets the initial capacity. |
int |
getMaximumCapacity()
Gets the maximum capacity. |
java.lang.String |
getName()
Gets the connection pool name. |
java.lang.String |
getServiceComponentName()
Gets the service component name. |
IEssConnectionPool.EEssConnectionPoolType |
getType()
Gets the connection pool type. |
java.lang.String |
getUserName()
Gets the user name with which connection will be established. |
boolean |
isAllowEveryone()
Checks if everyone is allowed. |
boolean |
isServiceComponentCluster()
Checks if the service component is a cluster. |
void |
refreshPropertyValues()
Refreshes the property values. |
void |
setAllowedGroupNames(java.lang.String groupNames)
Sets the allowed group names. |
void |
setAllowedUserNames(java.lang.String userNames)
Sets the allowed user names. |
void |
setAllowEveryone(boolean allowEveryOne)
Sets to allow everyone. |
void |
setCapacityIncrement(int capacityIncrement)
Sets the capacity increment. |
void |
setDescription(java.lang.String desc)
Sets the connection pool description. |
void |
setInitialCapacity(int initialCapacity)
Sets the initial capacity. |
void |
setMaximumCapacity(int maxCapacity)
Sets the maximum capacity. |
void |
setPassword(java.lang.String password)
Sets the password of the user to establish the connection. |
void |
setServiceComponentCluster(boolean cluster)
Sets if the service component is a cluster. |
void |
setServiceComponentName(java.lang.String svcCompName)
Sets the service component name. |
void |
setType(IEssConnectionPool.EEssConnectionPoolType type)
Sets the connection pool type. |
void |
setUserName(java.lang.String userName)
Sets the user name with which connection will be established. |
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 |
public static final int PROP_NAME
public static final int PROP_DESCRIPTION
public static final int PROP_SERVICE_COMPONENT_NAME
public static final int PROP_SERVICE_COMPONENT_IS_CLUSTER
public static final int PROP_USER_NAME
public static final int PROP_PASSWORD
public static final int PROP_INITIAL_CAPACITY
public static final int PROP_MAXIMUM_CAPACITY
public static final int PROP_CAPACITY_INCREMENT
public static final int PROP_ALLOW_EVERYONE
public static final int PROP_ALLOWED_USERS
public static final int PROP_ALLOWED_GROUPS
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 connection pool description.
EssException - if an error occurs.
public IEssConnectionPool.EEssConnectionPoolType getType()
throws EssException
EssException - if an error occurs.
public void setType(IEssConnectionPool.EEssConnectionPoolType type)
throws EssException
type - The connection pool type.
EssException - if an error occurs.
public java.lang.String getServiceComponentName()
throws EssException
EssException - if an error occurs.
public void setServiceComponentName(java.lang.String svcCompName)
throws EssException
svcCompName - The service component name.
EssException - if an error occurs.
public boolean isServiceComponentCluster()
throws EssException
EssException - if an error occurs.
public void setServiceComponentCluster(boolean cluster)
throws EssException
cluster - true if the service component is a cluster.
EssException - if an error occurs.
public java.lang.String getUserName()
throws EssException
EssException - if an error occurs.
public void setUserName(java.lang.String userName)
throws EssException
userName - The user name with which connection will be established.
EssException - if an error occurs.
public void setPassword(java.lang.String password)
throws EssException
password - The password of the user to establish the connection.
EssException - if an error occurs.
public int getInitialCapacity()
throws EssException
EssException - if an error occurs.
public void setInitialCapacity(int initialCapacity)
throws EssException
initialCapacity - The initial capacity.
EssException - if an error occurs.
public int getMaximumCapacity()
throws EssException
EssException - if an error occurs.
public void setMaximumCapacity(int maxCapacity)
throws EssException
maxCapacity - The maximum capacity.
EssException - if an error occurs.
public int getCapacityIncrement()
throws EssException
EssException - if an error occurs.
public void setCapacityIncrement(int capacityIncrement)
throws EssException
capacityIncrement - The capacity increment.
EssException - if an error occurs.
public boolean isAllowEveryone()
throws EssException
EssException - if an error occurs.
public void setAllowEveryone(boolean allowEveryOne)
throws EssException
allowEveryOne - true to allow everyone.
EssException - if an error occurs.
public java.lang.String getAllowedUserNames()
throws EssException
EssException - if an error occurs.
public void setAllowedUserNames(java.lang.String userNames)
throws EssException
userNames - The allowed user names
EssException - if an error occurs.
public java.lang.String getAllowedGroupNames()
throws EssException
EssException - if an error occurs.
public void setAllowedGroupNames(java.lang.String groupNames)
throws EssException
groupNames - The allowed group names
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
EssException - if an error occurs.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||