com.bmc.arsys.api
Class ProxyManager.PoolInfo

java.lang.Object
  com.bmc.arsys.api.ProxyManager.PoolInfo

Enclosing class:

ProxyManager

public static class ProxyManager.PoolInfo
extends Object

Constructor Summary

ProxyManager.PoolInfo(int maxProxyPerServer, int idleConnectionsPerServer, long connectionTimeout, ARTimeUnit unit)
public construction to be used as parameter in adjustConnectionPoolVariables.

Method Summary

int	getIdleConnectionsPerServer()
long	getPoolConnectionLifespan() get connectionLifespan for current PoolInfo's unit
String	getPoolConnectionLifespanElapsedTimeFormated()
long	getPoolConnectionTimeout() get connectionTimeout time in in current PoolInfo's unit
String	getPoolConnectionTimeoutElapsedTimeFormated()
long	getPoolEstablish() get the system time this pool is established
String	getPoolEstablishTimeFormated() get establish time in format of "MMM dd yyyy HH:mm:ss"
int	getPoolFree()
int	getPoolInUse()
int	getPoolLargestReachedPoolSize()
long	getPoolLastUsed()
String	getPoolLastUsedTimeFormated() get last used time in format of "MMM dd yyyy HH:mm:ss"
int	getPoolMaxProxyPerServer()
int	getPoolNotCreated()
String	getPoolServerName()
ARTimeUnit	getPoolUnit()
void	setIdleConnectionsPerServer(int idleConnectionsPerServer)
void	setPoolConnectionLifespan(long newConnectionLifespan) set the connectionLifespan in current PoolInfo's unit
void	setPoolConnectionTimeout(long newConnectionTimeout) set the connectionTimeout in current PoolInfo's unit
void	setPoolMaxProxyPerServer(int mMaxProxyPerServer)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProxyManager.PoolInfo

public ProxyManager.PoolInfo(int maxProxyPerServer,
                             int idleConnectionsPerServer,
                             long connectionTimeout,
                             ARTimeUnit unit)

public construction to be used as parameter in adjustConnectionPoolVariables.

maxProxyPerServer specifies the maximum number of proxy connections per server that the program can interact with.

idleConnectionsPerServer specifies the maximum number of idle connections per server that are not subject to the connectionTimeout limit. These connections can be idle indefinitely.

-- connections that exceed idleConnectionsPerServer can be idle before being terminated. This timeout triggers active pools to clean up their excess idle connections.

-- If the value of idleConnectionsPerServer is set to 0, then the connection pool will be closed when all connections are closed.

-- Whether the connectionLifespan or connectionTimeout setting is met first determines the number of current idle connections.

connectionTimeout and unit specify the amount of time in ARTimeUnits.

This object can be used in adjustConnectionPoolVariables to overwrite the existing values of the variables. It can be called before or after a connection pool is established. The size of an existing connection pool is adjusted according to the new settings.

Parameters:

maxProxyPerServer - Maximum number of proxy connections that a connection pool can contain for each server.

idleConnectionsPerServer - Number of idle connections per server that are not subject to the connectionTimeout limit. These connections can be idle indefinitely.

connectionTimeout - Number of unit. Connections that exceed idleConnectionsPerServer can be idle before being terminated. This time limit ensures that active pools regularly clean up their excess idle connections.

unit - ARTimeUnit for connectionTimeout. If the unit is null, connectionTimeout is considered in MILLISECONDS.

Method Detail

setPoolMaxProxyPerServer

public void setPoolMaxProxyPerServer(int mMaxProxyPerServer)

setIdleConnectionsPerServer

public void setIdleConnectionsPerServer(int idleConnectionsPerServer)

getPoolConnectionTimeout

public long getPoolConnectionTimeout()

get connectionTimeout time in in current PoolInfo's unit

Returns:

setPoolConnectionTimeout

public void setPoolConnectionTimeout(long newConnectionTimeout)

set the connectionTimeout in current PoolInfo's unit

Parameters:

newConnectionTimeout -

getPoolConnectionLifespan

public long getPoolConnectionLifespan()

get connectionLifespan for current PoolInfo's unit

Returns:

setPoolConnectionLifespan

public void setPoolConnectionLifespan(long newConnectionLifespan)

set the connectionLifespan in current PoolInfo's unit

Parameters:

newConnectionLifespan -

getPoolServerName

public String getPoolServerName()

getPoolInUse

public int getPoolInUse()

getPoolFree

public int getPoolFree()

getPoolNotCreated

public int getPoolNotCreated()

getPoolLastUsed

public long getPoolLastUsed()

getPoolLastUsedTimeFormated

public String getPoolLastUsedTimeFormated()

get last used time in format of "MMM dd yyyy HH:mm:ss"

Returns:

getPoolConnectionTimeoutElapsedTimeFormated

public String getPoolConnectionTimeoutElapsedTimeFormated()

getPoolEstablishTimeFormated

public String getPoolEstablishTimeFormated()

get establish time in format of "MMM dd yyyy HH:mm:ss"

Returns:

getPoolConnectionLifespanElapsedTimeFormated

public String getPoolConnectionLifespanElapsedTimeFormated()

getPoolMaxProxyPerServer

public int getPoolMaxProxyPerServer()

getIdleConnectionsPerServer

public int getIdleConnectionsPerServer()

getPoolEstablish

public long getPoolEstablish()

get the system time this pool is established

Returns:

getPoolLargestReachedPoolSize

public int getPoolLargestReachedPoolSize()

getPoolUnit

public ARTimeUnit getPoolUnit()

toString

public String toString()

Overrides:

toString in class Object