com.essbase.api.domain

Interface IEssConnectionPool

All Superinterfaces:

IEssBaseObject, IEssExtendedObject, IEssProperties

Deprecated.

This interface has been deprecated. Connection pools are no longer supported.

public interface IEssConnectionPool
extends IEssExtendedObject, IEssProperties

The IEssConnectionPool is a connection pool definition.

Version:

1.0, 04/04/2002

Author:

Srini Ranga

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IEssConnectionPool.EEssConnectionPoolType Deprecated. The EEssConnectionPoolType class is an enumeration of server types.

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

IEssProperties.EEssPropertyMode

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROP_ALLOW_EVERYONE Deprecated.
static int	PROP_ALLOWED_GROUPS Deprecated.
static int	PROP_ALLOWED_USERS Deprecated.
static int	PROP_CAPACITY_INCREMENT Deprecated.
static int	PROP_DESCRIPTION Deprecated.
static int	PROP_INITIAL_CAPACITY Deprecated.
static int	PROP_MAXIMUM_CAPACITY Deprecated.
static int	PROP_NAME Deprecated.
static int	PROP_PASSWORD Deprecated.
static int	PROP_SERVICE_COMPONENT_IS_CLUSTER Deprecated.
static int	PROP_SERVICE_COMPONENT_NAME Deprecated.
static int	PROP_USER_NAME Deprecated.
static int	PROP_WAIT_FOR_CONNECTION_TIMEOUT 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

Modifier and Type	Method and Description
void	delete() Deprecated. Deletes this connection pool.
java.lang.String	getAllowedGroupNames() Deprecated. Gets the allowed group names.
java.lang.String	getAllowedUserNames() Deprecated. Gets the allowed user names.
int	getCapacityIncrement() Deprecated. Gets the capacity increment.
int	getConnectionWaitTimeout() Deprecated. Gets the connection wait timeout value in seconds.
java.lang.String	getDescription() Deprecated. Gets the connection pool description.
int	getInitialCapacity() Deprecated. Gets the initial capacity.
int	getMaximumCapacity() Deprecated. Gets the maximum capacity.
java.lang.String	getName() Deprecated. Gets the connection pool name.
java.lang.String	getServiceComponentName() Deprecated. Gets the service component name.
IEssConnectionPool.EEssConnectionPoolType	getType() Deprecated. Gets the connection pool type.
java.lang.String	getUserName() Deprecated. Gets the user name with which connection will be established.
boolean	isAllowEveryone() Deprecated. Checks if everyone is allowed.
boolean	isServiceComponentCluster() Deprecated. Checks if the service component is a cluster.
void	refreshPropertyValues() Deprecated. Refreshes the property values.
void	setAllowedGroupNames(java.lang.String groupNames) Deprecated. Sets the allowed group names.
void	setAllowedUserNames(java.lang.String userNames) Deprecated. Sets the allowed user names.
void	setAllowEveryone(boolean allowEveryOne) Deprecated. Sets to allow everyone.
void	setCapacityIncrement(int capacityIncrement) Deprecated. Sets the capacity increment.
void	setConnectionWaitTimeout(int timeout) Deprecated. Sets the connection wait timeout value in seconds.
void	setDescription(java.lang.String desc) Deprecated. Sets the connection pool description.
void	setInitialCapacity(int initialCapacity) Deprecated. Sets the initial capacity.
void	setMaximumCapacity(int maxCapacity) Deprecated. Sets the maximum capacity.
void	setPassword(java.lang.String password) Deprecated. Sets the password of the user to establish the connection.
void	setServiceComponentCluster(boolean cluster) Deprecated. Sets if the service component is a cluster.
void	setServiceComponentName(java.lang.String svcCompName) Deprecated. Sets the service component name.
void	setType(IEssConnectionPool.EEssConnectionPoolType type) Deprecated. Sets the connection pool type.
void	setUserName(java.lang.String userName) Deprecated. Sets the user name with which connection will be established.
void	updatePropertyValues() Deprecated. 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

Deprecated.

See Also:

Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION

Deprecated.

See Also:

Constant Field Values

PROP_SERVICE_COMPONENT_NAME

static final int PROP_SERVICE_COMPONENT_NAME

Deprecated.

See Also:

Constant Field Values

PROP_SERVICE_COMPONENT_IS_CLUSTER

static final int PROP_SERVICE_COMPONENT_IS_CLUSTER

Deprecated.

See Also:

Constant Field Values

PROP_USER_NAME

static final int PROP_USER_NAME

Deprecated.

See Also:

Constant Field Values

PROP_PASSWORD

static final int PROP_PASSWORD

Deprecated.

See Also:

Constant Field Values

PROP_INITIAL_CAPACITY

static final int PROP_INITIAL_CAPACITY

Deprecated.

See Also:

Constant Field Values

PROP_MAXIMUM_CAPACITY

static final int PROP_MAXIMUM_CAPACITY

Deprecated.

See Also:

Constant Field Values

PROP_CAPACITY_INCREMENT

static final int PROP_CAPACITY_INCREMENT

Deprecated.

See Also:

Constant Field Values

PROP_ALLOW_EVERYONE

static final int PROP_ALLOW_EVERYONE

Deprecated.

See Also:

Constant Field Values

PROP_ALLOWED_USERS

static final int PROP_ALLOWED_USERS

Deprecated.

See Also:

Constant Field Values

PROP_ALLOWED_GROUPS

static final int PROP_ALLOWED_GROUPS

Deprecated.

See Also:

Constant Field Values

PROP_WAIT_FOR_CONNECTION_TIMEOUT

static final int PROP_WAIT_FOR_CONNECTION_TIMEOUT

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 connection pool name.

Specified by:

getName in interface IEssExtendedObject

Returns:

The connection pool name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getDescription

java.lang.String getDescription()
                         throws com.essbase.api.base.EssException

Deprecated.

Gets the connection pool description.

Returns:

The connection pool 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 connection pool description. The change will become effective after you invoke updatePropertyValues().

Parameters:

desc - The connection pool description.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getType

IEssConnectionPool.EEssConnectionPoolType getType()
                                           throws com.essbase.api.base.EssException

Deprecated.

Gets the connection pool type.

Returns:

The connection pool type.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setType

void setType(IEssConnectionPool.EEssConnectionPoolType type)
      throws com.essbase.api.base.EssException

Deprecated.

Sets the connection pool type. The change will become effective after you invoke updatePropertyValues().

Parameters:

type - The connection pool type.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getServiceComponentName

java.lang.String getServiceComponentName()
                                  throws com.essbase.api.base.EssException

Deprecated.

Gets the service component name.

Returns:

The service component name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setServiceComponentName

void setServiceComponentName(java.lang.String svcCompName)
                      throws com.essbase.api.base.EssException

Deprecated.

Sets the service component name. The change will become effective after you invoke updatePropertyValues().

Parameters:

svcCompName - The service component name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

isServiceComponentCluster

boolean isServiceComponentCluster()
                           throws com.essbase.api.base.EssException

Deprecated.

Checks if the service component is a cluster.

Returns:

true if the service component is a cluster.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setServiceComponentCluster

void setServiceComponentCluster(boolean cluster)
                         throws com.essbase.api.base.EssException

Deprecated.

Sets if the service component is a cluster. The change will become effective after you invoke updatePropertyValues().

Parameters:

cluster - true if the service component is a cluster.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getUserName

java.lang.String getUserName()
                      throws com.essbase.api.base.EssException

Deprecated.

Gets the user name with which connection will be established.

Returns:

The user name with which connection will be established.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setUserName

void setUserName(java.lang.String userName)
          throws com.essbase.api.base.EssException

Deprecated.

Sets the user name with which connection will be established. The change will become effective after you invoke updatePropertyValues().

Parameters:

userName - The user name with which connection will be established.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setPassword

void setPassword(java.lang.String password)
          throws com.essbase.api.base.EssException

Deprecated.

Sets the password of the user to establish the connection. The change will become effective after you invoke updatePropertyValues().

Parameters:

password - The password of the user to establish the connection.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getInitialCapacity

int getInitialCapacity()
                throws com.essbase.api.base.EssException

Deprecated.

Gets the initial capacity.

Returns:

The initial capacity.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setInitialCapacity

void setInitialCapacity(int initialCapacity)
                 throws com.essbase.api.base.EssException

Deprecated.

Sets the initial capacity. The change will become effective after you invoke updatePropertyValues().

Parameters:

initialCapacity - The initial capacity.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getMaximumCapacity

int getMaximumCapacity()
                throws com.essbase.api.base.EssException

Deprecated.

Gets the maximum capacity.

Returns:

The maximum capacity.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setMaximumCapacity

void setMaximumCapacity(int maxCapacity)
                 throws com.essbase.api.base.EssException

Deprecated.

Sets the maximum capacity. The change will become effective after you invoke updatePropertyValues().

Parameters:

maxCapacity - The maximum capacity.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getCapacityIncrement

int getCapacityIncrement()
                  throws com.essbase.api.base.EssException

Deprecated.

Gets the capacity increment.

Returns:

The capacity increment.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setCapacityIncrement

void setCapacityIncrement(int capacityIncrement)
                   throws com.essbase.api.base.EssException

Deprecated.

Sets the capacity increment. The change will become effective after you invoke updatePropertyValues().

Parameters:

capacityIncrement - The capacity increment.

Throws:

com.essbase.api.base.EssException - if an error occurs.

isAllowEveryone

boolean isAllowEveryone()
                 throws com.essbase.api.base.EssException

Deprecated.

Checks if everyone is allowed.

Returns:

true if everyone is allowed.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setAllowEveryone

void setAllowEveryone(boolean allowEveryOne)
               throws com.essbase.api.base.EssException

Deprecated.

Sets to allow everyone. If this is set to false, allowed user/group names takes effect. The change will become effective after you invoke updatePropertyValues().

Parameters:

allowEveryOne - true to allow everyone.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getAllowedUserNames

java.lang.String getAllowedUserNames()
                              throws com.essbase.api.base.EssException

Deprecated.

Gets the allowed user names.

Returns:

The allowed user names

Throws:

com.essbase.api.base.EssException - if an error occurs.

setAllowedUserNames

void setAllowedUserNames(java.lang.String userNames)
                  throws com.essbase.api.base.EssException

Deprecated.

Sets the allowed user names. The change will become effective after you invoke updatePropertyValues().

Parameters:

userNames - The allowed user names

Throws:

com.essbase.api.base.EssException - if an error occurs.

getAllowedGroupNames

java.lang.String getAllowedGroupNames()
                               throws com.essbase.api.base.EssException

Deprecated.

Gets the allowed group names.

Returns:

The allowed role names

Throws:

com.essbase.api.base.EssException - if an error occurs.

setAllowedGroupNames

void setAllowedGroupNames(java.lang.String groupNames)
                   throws com.essbase.api.base.EssException

Deprecated.

Sets the allowed group names. The change will become effective after you invoke updatePropertyValues().

Parameters:

groupNames - The allowed group names

Throws:

com.essbase.api.base.EssException - if an error occurs.

getConnectionWaitTimeout

int getConnectionWaitTimeout()
                      throws com.essbase.api.base.EssException

Deprecated.

Gets the connection wait timeout value in seconds.

Returns:

Connection pool wait timeout.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setConnectionWaitTimeout

void setConnectionWaitTimeout(int timeout)
                       throws com.essbase.api.base.EssException

Deprecated.

Sets the connection wait timeout value in seconds. If a valid connection is not found before this wait time, an exception is thrown. A default value of -1 means infinite wait. The change will become effective after you invoke updatePropertyValues().

Parameters:

timeout - The timeout value in seconds.

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 this connection pool.

Throws:

com.essbase.api.base.EssException - if an error occurs.