org.jppf.client

Class AbstractJPPFClientConnection

java.lang.Object

org.jppf.client.BaseJPPFClientConnection

org.jppf.client.AbstractJPPFClientConnection

All Implemented Interfaces:

JPPFClientConnection

Direct Known Subclasses:

JPPFClientConnectionImpl

public abstract class AbstractJPPFClientConnection
extends BaseJPPFClientConnection

This class provides an API to submit execution requests and administration commands, and request server information data.
It has its own unique identifier, used by the nodes, to determine whether classes from the submitting application should be dynamically reloaded or not depending on whether the uuid has changed or not.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed Determines whether this connection has been shut down;
protected String	displayName The name displayed for this connection.
protected JMXDriverConnectionWrapper	jmxConnection Provides access to the management functions of the driver.
protected int	jmxPort
protected List<ClientConnectionStatusListener>	listeners List of status listeners for this connection.
protected ClientConnectionStatusListener[]	listenersArray Temporary listeners array to allow access to the listeners without synchronization.
protected int	priority Priority given to the driver this client is connected to.
protected TypedProperties	props Contains the configuration properties for this client connection.
protected boolean	ssl Determines whether the communication via the server is done via SSL.

Fields inherited from class org.jppf.client.BaseJPPFClientConnection

client, connectionCount, connectionUuid, delegate, host, job, name, ndclCache, port, SERIALIZATION_HELPER_IMPL, serializationHelperClassName, status, taskServerConnection, uuid

Constructor Summary

Constructors

Constructor and Description
AbstractJPPFClientConnection()

Method Summary

Methods

Modifier and Type	Method and Description
void	addClientConnectionStatusListener(ClientConnectionStatusListener listener) Add a connection status listener to this connection's list of listeners.
boolean	cancelJob(String jobId) Cancel the job with the specified id.
List<JPPFJob>	close() Shutdown this client and retrieve all pending executions for resubmission.
protected void	configure(String uuid, String name, String host, int driverPort, int priority, boolean ssl) Configure this client connection with the specified parameters.
protected abstract SocketInitializer	createSocketInitializer() Create a socket initializer.
void	delegateStatusChanged(ClientConnectionStatusEvent event) Invoked to notify of a status change event on a client connection.
protected void	fireStatusChanged(JPPFClientConnectionStatus oldStatus) Notify all listeners that the status of this connection has changed.
JPPFJob	getCurrentJob() Get the object that holds the tasks, data provider and submission mode for the current execution.
JMXDriverConnectionWrapper	getJmxConnection() Get the object that provides access to the management functions of the driver.
int	getPriority() Get the priority assigned to this connection.
JPPFClientConnectionStatus	getStatus() Get the status of this connection.
JPPFSystemInformation	getSystemInfo() Get the system information.
abstract void	init() Initialize this client connection.
void	initializeJmxConnection() Initialize the jmx connection using the specified jmx server id.
boolean	isClosed() Determine whether this connection has been shut down;
boolean	isSSL() Determines if this connection is over SSL.
protected void	processStatusChanged(JPPFClientConnectionStatus delegateStatus, JPPFClientConnectionStatus taskConnectionStatus) Handle a status change from either the class server delegate or the task server connection and determine whether it triggers a status change for the client connection.
void	removeClientConnectionStatusListener(ClientConnectionStatusListener listener) Remove a connection status listener from this connection's list of listeners.
JPPFTaskBundle	sendHandshakeJob() Send a handshake job to the server.
void	setCurrentJob(JPPFJob currentExecution) Set the object that holds the tasks, data provider and submission mode for the current execution.
void	setPriority(int priority) Set the priority assigned to this connection.
void	setStatus(JPPFClientConnectionStatus status) Set the status of this connection.
void	taskServerConnectionStatusChanged(ClientConnectionStatusEvent event) Invoked to notify of a status change event on a client connection.
String	toString() Get a string representation of this client connection.

Methods inherited from class org.jppf.client.BaseJPPFClientConnection

getClient, getConnectionUuid, getDelegate, getHost, getName, getPort, getSerializationHelperClassName, getTaskServerConnection, getUuid, makeHelper, makeHelper, receiveBundleAndResults, receiveResults, receiveResults, sendTasks, setSerializationHelperClassName, toDebugString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jppf.client.JPPFClientConnection

submit

Field Detail

priority

protected int priority

Priority given to the driver this client is connected to. The client is always connected to the available driver(s) with the highest priority. If multiple drivers have the same priority, they will be used as a pool and tasks will be evenly distributed among them.

listeners

protected final List<ClientConnectionStatusListener> listeners

List of status listeners for this connection.

listenersArray

protected ClientConnectionStatusListener[] listenersArray

Temporary listeners array to allow access to the listeners without synchronization.

closed

protected boolean closed

Determines whether this connection has been shut down;

displayName

protected String displayName

The name displayed for this connection.

ssl

protected boolean ssl

Determines whether the communication via the server is done via SSL.

jmxConnection

protected JMXDriverConnectionWrapper jmxConnection

Provides access to the management functions of the driver.

jmxPort

protected int jmxPort

props

protected TypedProperties props

Contains the configuration properties for this client connection.

Constructor Detail

AbstractJPPFClientConnection

public AbstractJPPFClientConnection()

Method Detail

configure

protected void configure(String uuid,
             String name,
             String host,
             int driverPort,
             int priority,
             boolean ssl)

Configure this client connection with the specified parameters.

Parameters:

uuid - the remote driver's UUID.

name - configuration name for this local client.

host - the name or IP address of the host the JPPF driver is running on.

driverPort - the TCP port the JPPF driver listening to for submitted tasks.

priority - the assigned to this client connection.

ssl - determines whether the communication via the server is done via SSL.

init

public abstract void init()

Initialize this client connection.

Specified by:

init in interface JPPFClientConnection

Specified by:

init in class BaseJPPFClientConnection

See Also:

JPPFClientConnection.init()

getPriority

public int getPriority()

Get the priority assigned to this connection.

Returns:

a priority as an int value.

See Also:

JPPFClientConnection.getPriority()

setPriority

public void setPriority(int priority)

Set the priority assigned to this connection.

Parameters:

priority - a priority as an int value.

getStatus

public JPPFClientConnectionStatus getStatus()

Get the status of this connection.

Returns:

a JPPFClientConnectionStatus enumerated value.

See Also:

ClientConnectionStatusHandler.getStatus()

setStatus

public void setStatus(JPPFClientConnectionStatus status)

Set the status of this connection.

Parameters:

status - a JPPFClientConnectionStatus enumerated value.

See Also:

ClientConnectionStatusHandler.setStatus(org.jppf.client.JPPFClientConnectionStatus)

addClientConnectionStatusListener

public void addClientConnectionStatusListener(ClientConnectionStatusListener listener)

Add a connection status listener to this connection's list of listeners.

Parameters:

listener - the listener to add to the list.

See Also:

ClientConnectionStatusHandler.addClientConnectionStatusListener(org.jppf.client.event.ClientConnectionStatusListener)

removeClientConnectionStatusListener

public void removeClientConnectionStatusListener(ClientConnectionStatusListener listener)

Remove a connection status listener from this connection's list of listeners.

Parameters:

listener - the listener to remove from the list.

See Also:

ClientConnectionStatusHandler.removeClientConnectionStatusListener(org.jppf.client.event.ClientConnectionStatusListener)

fireStatusChanged

protected void fireStatusChanged(JPPFClientConnectionStatus oldStatus)

Notify all listeners that the status of this connection has changed.

Parameters:

oldStatus - the connection status before the change.

toString

public String toString()

Get a string representation of this client connection.

Overrides:

toString in class Object

Returns:

a string representing this connection.

See Also:

Object.toString()

createSocketInitializer

protected abstract SocketInitializer createSocketInitializer()

Create a socket initializer.

Specified by:

createSocketInitializer in class BaseJPPFClientConnection

Returns:

an instance of a class implementing SocketInitializer.

getCurrentJob

public JPPFJob getCurrentJob()

Get the object that holds the tasks, data provider and submission mode for the current execution.

Returns:

a JPPFJob instance.

setCurrentJob

public void setCurrentJob(JPPFJob currentExecution)

Set the object that holds the tasks, data provider and submission mode for the current execution.

Parameters:

currentExecution - a ClientExecution instance.

cancelJob

public boolean cancelJob(String jobId)
                  throws Exception

Cancel the job with the specified id.

Parameters:

jobId - the id of the job to cancel.

Returns:

a true when cancel was successful false otherwise.

Throws:

Exception - if any error occurs.

See Also:

DriverJobManagementMBean.cancelJob(java.lang.String)

delegateStatusChanged

public void delegateStatusChanged(ClientConnectionStatusEvent event)

Invoked to notify of a status change event on a client connection.

Parameters:

event - the event to notify of.

See Also:

ClientConnectionStatusListener.statusChanged(org.jppf.client.event.ClientConnectionStatusEvent)

taskServerConnectionStatusChanged

public void taskServerConnectionStatusChanged(ClientConnectionStatusEvent event)

Invoked to notify of a status change event on a client connection.

Parameters:

event - the event to notify of.

See Also:

ClientConnectionStatusListener.statusChanged(org.jppf.client.event.ClientConnectionStatusEvent)

processStatusChanged

protected void processStatusChanged(JPPFClientConnectionStatus delegateStatus,
                        JPPFClientConnectionStatus taskConnectionStatus)

Handle a status change from either the class server delegate or the task server connection and determine whether it triggers a status change for the client connection.

Parameters:

delegateStatus - status of the class server delegate connection.

taskConnectionStatus - status of the task server connection.

isSSL

public boolean isSSL()

Description copied from interface: JPPFClientConnection

Determines if this connection is over SSL.

Returns:

true if this is an SSL connection, false otherwise.

getSystemInfo

public JPPFSystemInformation getSystemInfo()

Get the system information.

Returns:

a JPPFSystemInformation instance.

sendHandshakeJob

public JPPFTaskBundle sendHandshakeJob()
                                throws Exception

Description copied from class: BaseJPPFClientConnection

Send a handshake job to the server.

Overrides:

sendHandshakeJob in class BaseJPPFClientConnection

Returns:

a JPPFTaskBundlesent by the server in response to the handshake job.

Throws:

Exception - if an error occurs while sending the request.

initializeJmxConnection

public void initializeJmxConnection()

Initialize the jmx connection using the specified jmx server id.

getJmxConnection

public JMXDriverConnectionWrapper getJmxConnection()

Get the object that provides access to the management functions of the driver.

Returns:

a JMXConnectionWrapper instance.

close

public List<JPPFJob> close()

Shutdown this client and retrieve all pending executions for resubmission.

Specified by:

close in interface JPPFClientConnection

Specified by:

close in class BaseJPPFClientConnection

Returns:

a list of JPPFJob instances to resubmit; this list may be empty, but never null.

See Also:

JPPFClientConnection.close()

isClosed

public boolean isClosed()

Determine whether this connection has been shut down;

Returns:

true if this connection has been closed, false otherwise.