Package com.kheops.jmap.net

Class JMapServerRemoteConnectionPool

java.lang.Object

com.kheops.util.KObjectPool<JMapConnection>

com.kheops.jmap.net.JMapServerRemoteConnectionPool

All Implemented Interfaces:

KSchedulerClient

public class JMapServerRemoteConnectionPool
extends KObjectPool<JMapConnection>

A class that manages a pool of connections to remote instance of JMapServer. A unique session is opened on the remote server and it is available through the method getSessionId() to be used by all connections of the pool.

Field Summary

Fields inherited from class com.kheops.util.KObjectPool

cleanupPeriod, recyclePeriod, shrinkTime, TIMEOUT_UNDEFINED, TIMEOUT_UNLIMITED

Constructor Summary

Constructors

Constructor	Description
JMapServerRemoteConnectionPool()	Creates a new JMapServerRemoteConnectionPool instance.
JMapServerRemoteConnectionPool(JMapServerRemoteConnectionPoolInfo poolInfo)	Deprecated. use the default constructor and init(JMapServerRemoteConnectionPoolInfo)

Method Summary

Modifier and Type	Method	Description
void	activate()
void	addListener(JMapServerRemoteConnectionPoolListener listener)
JMapConnection	borrowConnection()	Gets a free connection from the connection pool
JMapConnection	borrowConnection(long timeout, TimeUnit unit)	Gets a free connection from the connection pool
JMapConnection	create()	Creates the object encapsulating the appropriate object
void	deactivate()
void	expire(JMapConnection connection)	This method closes the object
protected int	getId()
JMapServerRemoteConnectionPoolInfo	getJMapServerRemoteConnectionPoolInfo()
protected long	getSystemDefaultTimeout()
boolean	init(JMapServerRemoteConnectionPoolInfo poolInfo)	Initializes the connection pool with the specified pool info.
protected void	internalErrorOccurred(Exception e)
boolean	isInactive()
void	removeListener(JMapServerRemoteConnectionPoolListener listener)
protected void	resourceAdded(JMapConnection o)	No-op hook that allows implementation instructions after resource creation.
void	returnConnection(JMapConnection connection)	This method will free up the specified connection instance
boolean	validate(JMapConnection connection)	This method checks if the specified object qualifies for connections

Methods inherited from class com.kheops.util.KObjectPool

apply, checkIn, checkOut, checkOut, close, createUnlockedInstance, getDefaultTimeout, getMonitoringInfo, getPoolMaximumSize, getPoolSize, getPoolUsageCount, getPoolUsagePeak, initialize, initialize, initialize, reset, schCallback, setDefaultTimeout, setPoolMaximumSize, setPoolMinimumSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JMapServerRemoteConnectionPool

public JMapServerRemoteConnectionPool()

Creates a new JMapServerRemoteConnectionPool instance.

Since:

6.5

See Also:

• init(JMapServerRemoteConnectionPoolInfo)

JMapServerRemoteConnectionPool

@Deprecated
public JMapServerRemoteConnectionPool(JMapServerRemoteConnectionPoolInfo poolInfo)
                               throws Exception

Deprecated.

use the default constructor and init(JMapServerRemoteConnectionPoolInfo)

Throws:

Exception

Method Details

init

public boolean init(JMapServerRemoteConnectionPoolInfo poolInfo)

Initializes the connection pool with the specified pool info.

Parameters:

poolInfo - all pool informations needed to initialize the connection pool.

Returns:

true if no error occurred during the initialization.

Since:

6.5

getJMapServerRemoteConnectionPoolInfo

public JMapServerRemoteConnectionPoolInfo getJMapServerRemoteConnectionPoolInfo()

create

public JMapConnection create()
                      throws IOException

Description copied from class: KObjectPool

Creates the object encapsulating the appropriate object

Specified by:

create in class KObjectPool<JMapConnection>

Returns:

the corresponding object

Throws:

IOException

expire

public void expire(JMapConnection connection)

Description copied from class: KObjectPool

This method closes the object

Specified by:

expire in class KObjectPool<JMapConnection>

Parameters:

connection - the object to be expired

getSystemDefaultTimeout

protected long getSystemDefaultTimeout()

Overrides:

getSystemDefaultTimeout in class KObjectPool<JMapConnection>

validate

public boolean validate(JMapConnection connection)

This method checks if the specified object qualifies for connections

Specified by:

validate in class KObjectPool<JMapConnection>

Parameters:

connection - the corresponding object

Returns:

true if the object qualifies for connection false otherwise

getId

protected int getId()

Overrides:

getId in class KObjectPool<JMapConnection>

internalErrorOccurred

protected void internalErrorOccurred(Exception e)

Overrides:

internalErrorOccurred in class KObjectPool<JMapConnection>

returnConnection

public void returnConnection(JMapConnection connection)

This method will free up the specified connection instance

Parameters:

connection - the corresponding connection instance to be freed

borrowConnection

public JMapConnection borrowConnection()
                                throws IOException

Gets a free connection from the connection pool

Returns:

a free JMapConnection instance from the connection pool

Throws:

IOException

borrowConnection

public JMapConnection borrowConnection(long timeout,
 TimeUnit unit)
                                throws IOException

Gets a free connection from the connection pool

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

a free JMapConnection instance from the connection pool

Throws:

IOException

resourceAdded

protected void resourceAdded(JMapConnection o)

Description copied from class: KObjectPool

No-op hook that allows implementation instructions after resource creation.

Overrides:

resourceAdded in class KObjectPool<JMapConnection>

Parameters:

o - the corresponding object

addListener

public void addListener(JMapServerRemoteConnectionPoolListener listener)

removeListener

public void removeListener(JMapServerRemoteConnectionPoolListener listener)

isInactive

public boolean isInactive()

activate

public void activate()

deactivate

public void deactivate()