org.jppf.client

Class AbstractGenericClient

java.lang.Object

org.jppf.client.AbstractJPPFClient

org.jppf.client.AbstractGenericClient

All Implemented Interfaces:

AutoCloseable, EventListener, ClientConnectionStatusListener, org.jppf.queue.QueueListener

Direct Known Subclasses:

JPPFClient

public abstract class AbstractGenericClient
extends AbstractJPPFClient
implements org.jppf.queue.QueueListener

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 inherited from class org.jppf.client.AbstractJPPFClient

config

Constructor Summary

Constructors

Constructor and Description
AbstractGenericClient(String uuid, org.jppf.utils.TypedProperties configuration, ConnectionPoolListener... listeners) Initialize this client with a specified application UUID.

Method Summary

Modifier and Type	Method and Description
void	addClientQueueListener(ClientQueueListener listener) Register the specified listener to receive client queue event notifications.
void	addDriverDiscovery(org.jppf.discovery.ClientDriverDiscovery discovery) Add a custom driver discovery mechanism to those already registered, if any.
boolean	cancelJob(String jobId) Cancel the job with the specified id.
void	close() Close this client and release all the resources it is using.
org.jppf.load.balancer.persistence.LoadBalancerPersistenceManagement	getLoadBalancerPersistenceManagement() Get the object that manages the persisted states of the load-balancers.
boolean	hasAvailableConnection() Determine whether there is a client connection available for execution.
protected void	init(org.jppf.utils.TypedProperties configuration) Initialize this client with the specified configuration.
protected void	initPools(org.jppf.utils.TypedProperties config) Read all client connection information from the configuration and initialize the connection pools accordingly.
boolean	isLocalExecutionEnabled() Determine whether local execution is enabled on this client.
boolean	isSysoutEnabled() Determine whether the client should print connection events to stdout.
ClassLoader	registerClassLoader(ClassLoader cl, String uuid) Register a class loader for the specified job uuid.
void	removeClientQueueListener(ClientQueueListener listener) Unregister the specified listener.
void	setLocalExecutionEnabled(boolean localExecutionEnabled) Specify whether local execution is enabled on this client.

Methods inherited from class org.jppf.client.AbstractJPPFClient

addConnectionPoolListener, findConnectionPool, findConnectionPool, findConnectionPool, findConnectionPools, findConnectionPools, findConnectionPools, getAllConnectionsCount, getClientConnection, getConfig, getConnectionPool, getConnectionPools, getConnectionPools, getPoolPriorities, getUuid, isClosed, removeConnectionPoolListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jppf.queue.QueueListener

bundleAdded, bundleRemoved

Methods inherited from interface org.jppf.client.event.ClientConnectionStatusListener

statusChanged

Constructor Detail

AbstractGenericClient

public AbstractGenericClient(String uuid,
                             org.jppf.utils.TypedProperties configuration,
                             ConnectionPoolListener... 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

init

protected void init(org.jppf.utils.TypedProperties configuration)

Initialize this client with the specified configuration.

Parameters:

configuration - the configuration to use with this client.

initPools

protected void initPools(org.jppf.utils.TypedProperties config)

Description copied from class: AbstractJPPFClient

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

Parameters:

config - the JPPF configuration properties.

close

public void close()

Description copied from class: AbstractJPPFClient

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

Specified by:

close in interface AutoCloseable

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.

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 ClassLoader registerClassLoader(ClassLoader cl,
                                       String uuid)

Register a class loader for the specified job uuid.

Parameters:

cl - the ClassLoader instance to register.

uuid - the uuid of the job for which the class loader is registered.

Returns:

a RegisteredClassLoader instance.

addClientQueueListener

public void addClientQueueListener(ClientQueueListener listener)

Register the specified listener to receive client queue event notifications.

Parameters:

listener - the listener to register.

Since:

4.1

removeClientQueueListener

public void removeClientQueueListener(ClientQueueListener listener)

Unregister the specified listener.

Parameters:

listener - the listener to unregister.

Since:

4.1

getLoadBalancerPersistenceManagement

public org.jppf.load.balancer.persistence.LoadBalancerPersistenceManagement getLoadBalancerPersistenceManagement()

Get the object that manages the persisted states of the load-balancers.

Returns:

an instance of LoadBalancerPersistenceManagement.

Since:

6.0

addDriverDiscovery

public void addDriverDiscovery(org.jppf.discovery.ClientDriverDiscovery discovery)

Add a custom driver discovery mechanism to those already registered, if any.

Parameters:

discovery - the driver discovery to add.

isSysoutEnabled

public boolean isSysoutEnabled()

Determine whether the client should print connection events to stdout.

Returns:

true if the client should print ot the console, false otherwise.