ApiProxyPool (AR System Java API)

Constructor Summary

Constructors
Constructor and Description
`ApiProxyPool(String name, int maxProxiesPerServer)`
`ApiProxyPool(String name, int idleConnectionSize, int maximumPoolSize, long connectionTimeout, ARTimeUnit unit)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adjustPoolParameters(int maximumPoolSize, int idleConnectionsPerServer)` Set pool parameters and dynamically adjust the pool accordingly
`void`	`ageOutIdleProxy()` Proxies, which have no activities, are aged out.
`void`	`clear()` Clear this pool
`void`	`deRecodeProxy(ApiProxyI t)`
`boolean`	`equals(Object obj)`
`ApiProxyI`	`get(ApiUserContextI context)` Return a proxy from the pool.
`long`	`getEstablishTime()` get the system time this pool is established
`int`	`getLargestPoolSize()` Returns the largest number of proxies that have ever simultaneously been in the pool.
`long`	`getLastUsed()` get the system time this pool was used
`String`	`getPoolName()` get the pool name
`int`	`hashCode()`
`void`	`put(ApiProxyI proxy)` Return a proxy to the pool.
`void`	`setEstablishTime(long m_establishTime)` set the system time this pool is established
`void`	`setLastUsed(long tm)` set the system time this pool was used
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ApiProxyPool
```
public ApiProxyPool(String name,
                    int idleConnectionSize,
                    int maximumPoolSize,
                    long connectionTimeout,
                    ARTimeUnit unit)
```
  - ApiProxyPool
```
public ApiProxyPool(String name,
                    int maxProxiesPerServer)
```
- Method Detail
  - setLastUsed
```
public void setLastUsed(long tm)
```
    Description copied from interface: ApiProxyPoolI
    
    set the system time this pool was used
    
    Specified by:
    
    setLastUsed in interface ApiProxyPoolI
  - getLastUsed
```
public long getLastUsed()
```
    Description copied from interface: ApiProxyPoolI
    
    get the system time this pool was used
    
    Specified by:
    
    getLastUsed in interface ApiProxyPoolI
    
    Returns:
  - deRecodeProxy
```
public void deRecodeProxy(ApiProxyI t)
```
  - get
```
public ApiProxyI get(ApiUserContextI context)
              throws ARException
```
    Return a proxy from the pool. There are three cases: if the pool is not empty, return a proxy from the pool; if the pool is empty and the maximum number of connections have not been made, make a new proxy and return it; otherwise, wait until a proxy has been returned to the pool (making it not empty again) so one can be taken from the pool.
    
    Specified by:
    
    get in interface ApiProxyPoolI
    
    Returns:
    
    Throws:
    
    InterruptedException
    
    ARException
  - put
```
public void put(ApiProxyI proxy)
```
    Return a proxy to the pool. If there are waiters for the returned proxy, notify them.
    
    Specified by:
    
    put in interface ApiProxyPoolI
  - ageOutIdleProxy
```
public void ageOutIdleProxy()
```
    Proxies, which have no activities, are aged out.
  - adjustPoolParameters
```
public void adjustPoolParameters(int maximumPoolSize,
                                 int idleConnectionsPerServer)
```
    Set pool parameters and dynamically adjust the pool accordingly
    
    Parameters:
    
    maximumPoolSize -
    
    idleConnectionsPerServer -
  - getPoolName
```
public String getPoolName()
```
    Description copied from interface: ApiProxyPoolI
    
    get the pool name
    
    Specified by:
    
    getPoolName in interface ApiProxyPoolI
    
    Returns:
  - getLargestPoolSize
```
public int getLargestPoolSize()
```
    Returns the largest number of proxies that have ever simultaneously been in the pool.
    
    Returns:
    
    the number of proxies
  - clear
```
public void clear()
```
    Description copied from interface: ApiProxyPoolI
    
    Clear this pool
    
    Specified by:
    
    clear in interface ApiProxyPoolI
  - setEstablishTime
```
public void setEstablishTime(long m_establishTime)
```
    set the system time this pool is established
    
    Parameters:
    
    establishTime -
  - getEstablishTime
```
public long getEstablishTime()
```
    get the system time this pool is established
    
    Specified by:
    
    getEstablishTime in interface ApiProxyPoolI
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ApiProxyPool

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiProxyPool

ApiProxyPool

Method Detail

setLastUsed

getLastUsed

deRecodeProxy

get

put

ageOutIdleProxy

adjustPoolParameters

getPoolName

getLargestPoolSize

clear

setEstablishTime

getEstablishTime

hashCode

equals

toString