org.jppf.client

Class AbstractGenericClient

java.lang.Object

org.jppf.client.AbstractJPPFClient

org.jppf.client.AbstractGenericClient

All Implemented Interfaces:

EventListener, ClientConnectionStatusListener

Direct Known Subclasses:

JPPFClient

public abstract class AbstractGenericClient
extends AbstractJPPFClient

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractGenericClient.RegisteredClassLoader Helper class for managing registered class loaders.

Field Summary

Fields

Modifier and Type	Field and Description
protected ThreadPoolExecutor	executor The pool of threads used for submitting execution requests.
protected org.jppf.client.JPPFMulticastReceiverThread	receiverThread Performs server discovery.
protected boolean	sslEnabled Determines whether SSL communication is on or off.
protected static String	VALUE_JPPF_DISCOVERY Constant for JPPF automatic connection discovery

Fields inherited from class org.jppf.client.AbstractJPPFClient

totalTaskCount, uuid

Constructor Summary

Constructors

Constructor and Description
AbstractGenericClient(String uuid, Object configuration, ClientListener... listeners) Initialize this client with a specified application UUID.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequestClassLoader(String uuid, ClassLoader cl) Add a request uuid to class loader mapping to this submission manager.
boolean	cancelJob(String jobId) Cancel the job with the specified id.
void	close() Close this client and release all the resources it is using.
protected void	connectionFailed(JPPFClientConnection c) Invoked when the status of a connection has changed to JPPFClientConnectionStatus.FAILED.
protected abstract AbstractJPPFClientConnection	createConnection(String uuid, String name, JPPFConnectionInformation info, boolean ssl) Create a new driver connection based on the specified parameters.
protected abstract SubmissionManager	createSubmissionManager() Create the submission manager for this JPPF client.
TypedProperties	getConfig() Get JPPF configuration properties.
ThreadPoolExecutor	getExecutor() Get the pool of threads used for submitting execution requests.
ClassLoader	getRequestClassLoader(String uuid) Get a class loader from its request uuid.
boolean	hasAvailableConnection() Determine whether there is a client connection available for execution.
protected abstract TypedProperties	initConfig(Object configuration) Initialize this client's configuration.
protected void	initPools(TypedProperties config) Read all client connection information from the configuration and initialize the connection pools accordingly.
protected void	initRemotePools(TypedProperties props) Initialize remote connection pools according to configuration.
boolean	isLocalExecutionEnabled() Determine whether local execution is enabled on this client.
void	newConnection(JPPFClientConnection c) Invoked when a new connection is created.
protected void	newConnection(String name, JPPFConnectionInformation info, int priority, int poolSize, boolean ssl) Called when a new connection is read from the configuration (as opposed to discovered from the network).
AbstractGenericClient.RegisteredClassLoader	registerClassLoader(ClassLoader cl, String uuid) Register class loader with this submission manager.
void	removeRequestClassLoader(String uuid) Add a request uuid to class loader mapping to this submission manager.
void	setLocalExecutionEnabled(boolean localExecutionEnabled) Specify whether local execution is enabled on this client.
protected void	setSubmissionManager(SubmissionManager submissionManager) Set the submission manager for this JPPF client.
void	statusChanged(ClientConnectionStatusEvent event) Invoked when the status of a client connection has changed.
protected void	unregister(AbstractGenericClient.RegisteredClassLoader registeredClassLoader) Unregisters class loader from this submission manager.

Methods inherited from class org.jppf.client.AbstractJPPFClient

addClientConnection, addClientListener, fireConnectionFailed, fireNewConnection, getAllConnectionNames, getAllConnections, getAllConnectionsCount, getClientConnection, getClientConnection, getClientConnection, getClientConnection, getUuid, initCredentials, isClosed, removeClientConnection, removeClientListener, submit

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_JPPF_DISCOVERY

protected static final String VALUE_JPPF_DISCOVERY

Constant for JPPF automatic connection discovery

See Also:

Constant Field Values

executor

protected ThreadPoolExecutor executor

The pool of threads used for submitting execution requests.

receiverThread

protected org.jppf.client.JPPFMulticastReceiverThread receiverThread

Performs server discovery.

sslEnabled

protected boolean sslEnabled

Determines whether SSL communication is on or off.

Constructor Detail

AbstractGenericClient

public AbstractGenericClient(String uuid,
                     Object configuration,
                     ClientListener... listeners)

Initialize this client with a specified application UUID.

Parameters:

uuid - the unique identifier for this local client.

configuration - the object holding the JPPF configuration.

listeners - the listeners to add to this JPPF client to receive notifications of new connections.

Method Detail

getConfig

public TypedProperties getConfig()

Get JPPF configuration properties. These properties are unmodifiable.

Returns:

TypedProperties instance. With JPPF configuration.

initConfig

protected abstract TypedProperties initConfig(Object configuration)

Initialize this client's configuration.

Parameters:

configuration - an object holding the JPPF configuration.

Returns:

TypedProperties instance holding JPPF configuration. Never be null.

initPools

protected void initPools(TypedProperties config)

Description copied from class: AbstractJPPFClient

Read all client connection information from the configuration and initialize the connection pools accordingly.

Specified by:

initPools in class AbstractJPPFClient

Parameters:

config - The JPPF configuration properties.

initRemotePools

protected void initRemotePools(TypedProperties props)

Initialize remote connection pools according to configuration.

Parameters:

props - The JPPF configuration properties.

newConnection

protected void newConnection(String name,
                 JPPFConnectionInformation info,
                 int priority,
                 int poolSize,
                 boolean ssl)

Called when a new connection is read from the configuration (as opposed to discovered from the network).

Parameters:

name - the name assigned to the connection.

info - the information required for the connection to connect to the driver.

priority - the priority assigned to the connection.

poolSize - the size of the associated connection pool.

ssl - determines whether this is an SSL connection.

createConnection

protected abstract AbstractJPPFClientConnection createConnection(String uuid,
                                            String name,
                                            JPPFConnectionInformation info,
                                            boolean ssl)

Create a new driver connection based on the specified parameters.

Parameters:

uuid - the uuid of the JPPF client.

name - the name of the connection.

info - the driver connection information.

ssl - determines whether this is an SSL connection.

Returns:

an instance of a subclass of AbstractJPPFClientConnection.

newConnection

public void newConnection(JPPFClientConnection c)

Invoked when a new connection is created.

Overrides:

newConnection in class AbstractJPPFClient

Parameters:

c - the connection that failed.

See Also:

AbstractJPPFClient.newConnection(org.jppf.client.JPPFClientConnection)

connectionFailed

protected void connectionFailed(JPPFClientConnection c)

Invoked when the status of a connection has changed to JPPFClientConnectionStatus.FAILED.

Specified by:

connectionFailed in class AbstractJPPFClient

Parameters:

c - the connection that failed.

close

public void close()

Close this client and release all the resources it is using.

Overrides:

close in class AbstractJPPFClient

isLocalExecutionEnabled

public boolean isLocalExecutionEnabled()

Determine whether local execution is enabled on this client.

Returns:

true if local execution is enabled, false otherwise.

setLocalExecutionEnabled

public void setLocalExecutionEnabled(boolean localExecutionEnabled)

Specify whether local execution is enabled on this client.

Parameters:

localExecutionEnabled - true to enable local execution, false otherwise

hasAvailableConnection

public boolean hasAvailableConnection()

Determine whether there is a client connection available for execution.

Returns:

true if at least one connection is available, false otherwise.

statusChanged

public void statusChanged(ClientConnectionStatusEvent event)

Description copied from class: AbstractJPPFClient

Invoked when the status of a client connection has changed.

Specified by:

statusChanged in interface ClientConnectionStatusListener

Overrides:

statusChanged in class AbstractJPPFClient

Parameters:

event - the event to notify of.

See Also:

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

getExecutor

public ThreadPoolExecutor getExecutor()

Get the pool of threads used for submitting execution requests.

Returns:

a ThreadPoolExecutor instance.

addRequestClassLoader

public void addRequestClassLoader(String uuid,
                         ClassLoader cl)

Add a request uuid to class loader mapping to this submission manager.

Parameters:

uuid - the uuid of the request.

cl - the class loader for the request.

removeRequestClassLoader

public void removeRequestClassLoader(String uuid)

Add a request uuid to class loader mapping to this submission manager.

Parameters:

uuid - the uuid of the request.

getRequestClassLoader

public ClassLoader getRequestClassLoader(String uuid)

Get a class loader from its request uuid.

Parameters:

uuid - the uuid of the request.

Returns:

a ClassLoader instance, or null if none exists for the key.

setSubmissionManager

protected void setSubmissionManager(SubmissionManager submissionManager)

Set the submission manager for this JPPF client.

Parameters:

submissionManager - a JPPFSubmissionManager instance.

createSubmissionManager

protected abstract SubmissionManager createSubmissionManager()

Create the submission manager for this JPPF client.

Returns:

a JPPFSubmissionManager 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)

registerClassLoader

public AbstractGenericClient.RegisteredClassLoader registerClassLoader(ClassLoader cl,
                                                              String uuid)

Register class loader with this submission manager.

Parameters:

cl - a ClassLoader instance.

uuid - unique id assigned to classLoader. Added as temporary fix for problems hanging jobs.

Returns:

a RegisteredClassLoader instance.

unregister

protected void unregister(AbstractGenericClient.RegisteredClassLoader registeredClassLoader)

Unregisters class loader from this submission manager.

Parameters:

registeredClassLoader - a RegisteredClassLoader instance.