org.jppf.client

Class JPPFConnectionPool

java.lang.Object

org.jppf.client.AbstractConnectionPool<JPPFClientConnection>

org.jppf.client.JPPFConnectionPool

All Implemented Interfaces:

AutoCloseable, Comparable<JPPFConnectionPool>, Iterable<JPPFClientConnection>, ConnectionPool<JPPFClientConnection>

public class JPPFConnectionPool
extends AbstractConnectionPool<JPPFClientConnection>
implements Comparable<JPPFConnectionPool>

Instances of this class manage a list of client connections with the same pool name, priority and remote driver.

This connection pool also holds a pool of JMX connections to the same remote driver

Since:

4.1

Method Summary

Methods

Modifier and Type	Method and Description
JPPFClientConnection	awaitActiveConnection() Wait for the a connection to be in the ACTIVE status.
List<JPPFClientConnection>	awaitActiveConnections(Operator operator, int nbConnections) Wait for the specified number of connections to be in the ACTIVE status.
JPPFClientConnection	awaitConnection(JPPFClientConnectionStatus... statuses) Wait for a connection to be in one of the specified states.
List<JPPFClientConnection>	awaitConnections(Operator operator, int nbConnections, JPPFClientConnectionStatus... statuses) Wait for the specified number of connections to be in one of the specified states.
List<JPPFClientConnection>	awaitConnections(Operator operator, int nbConnections, long timeout, JPPFClientConnectionStatus... statuses) Wait for the specified number of connections to be in one of the specified states, or the specified timeout to expire, whichever happens first.
JMXDriverConnectionWrapper	awaitJMXConnection(boolean connectedOnly) Wait a JMX connection to be in the specified state.
List<JMXDriverConnectionWrapper>	awaitJMXConnections(Operator operator, int nbConnections, boolean connectedOnly) Wait for the specified number of JMX connections to be in the specified state.
List<JMXDriverConnectionWrapper>	awaitJMXConnections(Operator operator, int nbConnections, long timeout, boolean connectedOnly) Wait for the specified number of JMX connections to be in the specified state, or the specified timeout to expire, whichever happens first.
JPPFClientConnection	awaitWorkingConnection() Wait for a connection to be in the ACTIVE or EXECUTING status.
List<JPPFClientConnection>	awaitWorkingConnections(Operator operator, int nbConnections) Wait for the specified number of connections to be in the ACTIVE or EXECUTING status.
JMXDriverConnectionWrapper	awaitWorkingJMXConnection() Wait an established JMX connection to be available.
void	close()
int	compareTo(JPPFConnectionPool other) Compares this connection pool with another, based on their respective priorities.
int	connectionCount(JPPFClientConnectionStatus... statuses) Get the number of connections in this pool that have one of the psecified statuses.
boolean	equals(Object obj)
JPPFClient	getClient() Get the JPPF client which holds this pool.
JPPFClientConnection	getConnection() Get the next connection that is connected and available.
List<JPPFClientConnection>	getConnections(JPPFClientConnectionStatus... statuses) Get a list of connections held by this pool whose status is one of the specified statuses.
String	getDriverHost() Get the host name of the remote driver.
String	getDriverIPAddress() Get the ip address of the remote driver.
int	getDriverPort() Get the port to use on the remote driver.
String	getDriverUuid() Get the uuid of the driver to which connections in this pool are connected.
int	getId() Get the id of this pool.
JMXDriverConnectionWrapper	getJmxConnection() Get a connected JMX connection among those in the JMX pool.
JMXDriverConnectionWrapper	getJmxConnection(boolean connectedOnly) Get a JMX connection among those in the JMX pool.
List<JMXDriverConnectionWrapper>	getJMXConnections() Get the list of connections currently in the JMX pool.
int	getJMXPoolMaxSize() Get the current maximum size of the associated JMX connection pool.
int	getJmxPort() Get the jmx port to use on the remote driver.
String	getName() Get the name of this pool.
int	getPriority() Get the priority associated with this pool.
JPPFSystemInformation	getSystemInfo() Get the driver's system information.
int	hashCode()
boolean	isSslEnabled() Check whether this pool is for SSL connections.
int	setJMXPoolMaxSize(int maxSize) Set a new maximum size for the associated pool of JMX connections, adding new or closing existing connections as needed.
int	setSize(int newSize) Set the size of this connection pool, starting or stopping connections as needed.
String	toString()

Methods inherited from class org.jppf.client.AbstractConnectionPool

connectionCount, getConnections, getMaxSize, getSize, isEmpty, iterator, setMaxSize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getConnection

public JPPFClientConnection getConnection()

Description copied from interface: ConnectionPool

Get the next connection that is connected and available.

Specified by:

getConnection in interface ConnectionPool<JPPFClientConnection>

Returns:

a connection object if one is found in the desired state, or null otherwise.

connectionCount

public int connectionCount(JPPFClientConnectionStatus... statuses)

Get the number of connections in this pool that have one of the psecified statuses.

Warning: the execution time for this method is in O(n).

Parameters:

statuses - the set of connection statuses to look for.

Returns:

the size as an int.

getId

public int getId()

Get the id of this pool.

Returns:

the id as an int value.

getPriority

public int getPriority()

Get the priority associated with this pool.

Returns:

the priority as an int.

isSslEnabled

public boolean isSslEnabled()

Check whether this pool is for SSL connections.

Returns:

true if SSL is enabled, false otherwise.

getName

public String getName()

Get the name of this pool.

Returns:

this connection pool's name.

getDriverUuid

public String getDriverUuid()

Get the uuid of the driver to which connections in this pool are connected.

Returns:

the driver uuid as a string.

compareTo

public int compareTo(JPPFConnectionPool other)

Compares this connection pool with another, based on their respective priorities.

This comparison defines an ordering of connection pools by their descending priority.

Specified by:

compareTo in interface Comparable<JPPFConnectionPool>

Parameters:

other - the other connection pool to compare with.

Returns:

-1 if this pool's priority is greater than the other pool's, 0 if the priorities are equal, +1 if this pool's priority is less than the other pool's.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

setSize

public int setSize(int newSize)

Description copied from interface: ConnectionPool

Set the size of this connection pool, starting or stopping connections as needed.

If any connection to be stopped is currently executing a job, then it will not be stopped.

Specified by:

setSize in interface ConnectionPool<JPPFClientConnection>

Parameters:

newSize - the max size as an int.

Returns:

the new maximum pool size.

getConnections

public List<JPPFClientConnection> getConnections(JPPFClientConnectionStatus... statuses)

Get a list of connections held by this pool whose status is one of the specified statuses. The returned list is independent from this pool, thus changing, adding or removing elements has not effect on the pool.

Parameters:

statuses - an array of JPPFClientConnectionStatus values to check against.

Returns:

a list of JPPFClientConnection instances, possibly empty but never null.

awaitConnections

public List<JPPFClientConnection> awaitConnections(Operator operator,
                                          int nbConnections,
                                          long timeout,
                                          JPPFClientConnectionStatus... statuses)

Wait for the specified number of connections to be in one of the specified states, or the specified timeout to expire, whichever happens first. This method will increase or decrease the number of connections in this pool as needed.

Parameters:

operator - the condition on the number of connections to wait for. If null, it is assumed to be Operator.EQUAL.

nbConnections - the number of connections to wait for.

timeout - the maximum time to wait, in milliseconds.

statuses - the possible statuses of the connections to wait for.

Returns:

a list of JPPFClientConnection instances, possibly less than the requested number if the timeout expired first.

Since:

5.0

toString

public String toString()

Overrides:

toString in class AbstractConnectionPool<JPPFClientConnection>

getDriverHost

public String getDriverHost()

Get the host name of the remote driver.

Returns:

a string representing the host name or ip address.

Since:

4.2

getDriverIPAddress

public String getDriverIPAddress()

Get the ip address of the remote driver.

Returns:

a string representing the host name or ip address.

Since:

4.2

getDriverPort

public int getDriverPort()

Get the port to use on the remote driver.

Returns:

the port number as an int.

Since:

4.2

getClient

public JPPFClient getClient()

Get the JPPF client which holds this pool.

Returns:

a JPPFClient instance.

Since:

4.2

getSystemInfo

public JPPFSystemInformation getSystemInfo()

Get the driver's system information.

Returns:

an instance of JPPFSystemInformation.

Since:

4.2

getJmxPort

public int getJmxPort()

Get the jmx port to use on the remote driver.

Returns:

the jmx port number as an int.

Since:

4.2

getJmxConnection

public JMXDriverConnectionWrapper getJmxConnection()

Get a connected JMX connection among those in the JMX pool.

Returns:

a JMXDriverConnectionWrapper instance, or null if the JMX pool has no connected connection.

Since:

4.2

getJmxConnection

public JMXDriverConnectionWrapper getJmxConnection(boolean connectedOnly)

Get a JMX connection among those in the JMX pool.

Parameters:

connectedOnly - specifies whether to get a connection in connected state only or in any state.

Returns:

a JMXDriverConnectionWrapper instance, or null if the JMX pool has no connection in the specified state.

Since:

4.2

getJMXPoolMaxSize

public int getJMXPoolMaxSize()

Get the current maximum size of the associated JMX connection pool.

Returns:

the JMX pool maximum size.

Since:

4.2

setJMXPoolMaxSize

public int setJMXPoolMaxSize(int maxSize)

Set a new maximum size for the associated pool of JMX connections, adding new or closing existing connections as needed.

Parameters:

maxSize - the new maxsize to set.

Returns:

the actual new maximum size.

Since:

4.2

getJMXConnections

public List<JMXDriverConnectionWrapper> getJMXConnections()

Get the list of connections currently in the JMX pool.

Returns:

a list of JMXDriverConnectionWrapper instances.

Since:

4.2

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractConnectionPool<JPPFClientConnection>

awaitActiveConnections

public List<JPPFClientConnection> awaitActiveConnections(Operator operator,
                                                int nbConnections)

Wait for the specified number of connections to be in the ACTIVE status. This is a shorthand for awaitConnections(nbConnections, Long.MAX_VALUE, JPPFClientConnectionStatus.ACTIVE).

Parameters:

operator - the condition on the number of connections to wait for. If null, it is assumed to be Operator.EQUAL.

nbConnections - the expected number of connections to wait for.

Returns:

a list of nbConnections JPPFClientConnection instances with the desired status.

Since:

5.0

awaitActiveConnection

public JPPFClientConnection awaitActiveConnection()

Wait for the a connection to be in the ACTIVE status. This is a shorthand for awaitActiveConnections(Operator.AT_LEAST, 1).get(0).

Returns:

a JPPFClientConnection instances with the desired status.

Since:

5.1

awaitWorkingConnections

public List<JPPFClientConnection> awaitWorkingConnections(Operator operator,
                                                 int nbConnections)

Wait for the specified number of connections to be in the ACTIVE or EXECUTING status. This is a shorthand for awaitConnections(nbConnections, Long.MAX_VALUE, JPPFClientConnectionStatus.ACTIVE, JPPFClientConnectionStatus.EXECUTING).

Parameters:

operator - the condition on the number of connections to wait for. If null, it is assumed to be Operator.EQUAL.

nbConnections - the number of connections to wait for.

Returns:

a list of nbConnections JPPFClientConnection instances with the desired status.

Since:

5.0

awaitWorkingConnection

public JPPFClientConnection awaitWorkingConnection()

Wait for a connection to be in the ACTIVE or EXECUTING status. This is a shorthand for awaitWorkingConnections(Operator.AT_LEAST, 1).get(0).

Returns:

a list of nbConnections JPPFClientConnection instances with the desired status.

Since:

5.0

awaitConnections

public List<JPPFClientConnection> awaitConnections(Operator operator,
                                          int nbConnections,
                                          JPPFClientConnectionStatus... statuses)

Wait for the specified number of connections to be in one of the specified states. This is a shorthand for awaitConnections(nbConnections, Long.MAX_VALUE, JPPFstatuses).

Parameters:

operator - the condition on the number of connections to wait for. If null, it is assumed to be Operator.EQUAL.

nbConnections - the number of connections to wait for.

statuses - the possible statuses of the connections to wait for.

Returns:

a list of nbConnections JPPFClientConnection instances.

Since:

5.0

awaitConnection

public JPPFClientConnection awaitConnection(JPPFClientConnectionStatus... statuses)

Wait for a connection to be in one of the specified states. This is a shorthand for awaitConnections(Operator.AT_LEAST, 1, Long.MAX_VALUE, statuses).get(0).

Parameters:

statuses - the possible statuses of the connections to wait for.

Returns:

a JPPFClientConnection instance in one of the specified statuses.

Since:

5.1

awaitJMXConnections

public List<JMXDriverConnectionWrapper> awaitJMXConnections(Operator operator,
                                                   int nbConnections,
                                                   boolean connectedOnly)

Wait for the specified number of JMX connections to be in the specified state. This is a shorthand for awaitJMXConnections(nbConnections, Long.MAX_VALUE, connectedOnly).

Parameters:

operator - the condition on the number of connections to wait for. If null, it is assumed to be Operator.EQUAL.

nbConnections - the number of connections to wait for.

connectedOnly - specifies whether to get a connection in connected state only or in any state.

Returns:

a list of at least nbConnections JMXDriverConnectionWrapper instances.

Since:

5.0

awaitJMXConnections

public List<JMXDriverConnectionWrapper> awaitJMXConnections(Operator operator,
                                                   int nbConnections,
                                                   long timeout,
                                                   boolean connectedOnly)

Wait for the specified number of JMX connections to be in the specified state, or the specified timeout to expire, whichever happens first.

Parameters:

operator - the condition on the number of connections to wait for. If null, it is assumed to be Operator.EQUAL.

nbConnections - the number of connections to wait for.

timeout - the maximum time to wait, in milliseconds.

connectedOnly - specifies whether to get a connection in connected state only or in any state.

Returns:

a list of JMXDriverConnectionWrapper instances, possibly less than the requested number if the timeout expired first.

Since:

5.0

awaitJMXConnection

public JMXDriverConnectionWrapper awaitJMXConnection(boolean connectedOnly)

Wait a JMX connection to be in the specified state. This is a shorthand for awaitJMXConnections(Operator.AT_LEAST, 1, connectedOnly).get(0).

Parameters:

connectedOnly - specifies whether to get a connection in connected state only or in any state.

Returns:

a JMXDriverConnectionWrapper instance in the specified connected state.

Since:

5.1

awaitWorkingJMXConnection

public JMXDriverConnectionWrapper awaitWorkingJMXConnection()

Wait an established JMX connection to be available. This is a shorthand for awaitJMXConnections(Operator.AT_LEAST, 1, true).get(0).

Returns:

a connected JMXDriverConnectionWrapper instance.

Since:

5.1