ca.eandb.jdcp

Class JdcpUtil

java.lang.Object

ca.eandb.jdcp.JdcpUtil

public final class JdcpUtil
extends Object

Convenience methods for working with JDCP.

Author:

Brad Kimmel

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT The default port that a JDCP server listens on.
static UUID	PROTOCOL_VERSION_ID Uniquely identifies the protocol used for communication between clients and a server.

Method Summary

Modifier and Type	Method and Description
static JobService	connect(String host, String username, String password) Connects to a JDCP server.
static File	getHomeDirectory() Gets the folder at which JDCP application data is stored.
static HostService	getHostService() Gets the currently active HostService.
static void	initialize() Performs initialization for the currently running JDCP application.
static void	registerTaskService(String name, TaskService taskService, String host, String username, String password) Connects to a job server and provides a source of tasks to be processed.
static UUID	submitJob(ParallelizableJob job, String description, String host, String username, String password) Submits a job to a server for processing.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port that a JDCP server listens on.

See Also:

Constant Field Values

PROTOCOL_VERSION_ID

public static final UUID PROTOCOL_VERSION_ID

Uniquely identifies the protocol used for communication between clients and a server. This is used for verifying protocol compatibility when authenticating with the server.

Method Detail

connect

public static JobService connect(String host,
                                 String username,
                                 String password)
                          throws RemoteException,
                                 NotBoundException,
                                 LoginException,
                                 ProtocolVersionException

Connects to a JDCP server.

Parameters:

host - The host name of the server to send the job to.

username - The user name to use to authenticate with the server.

password - The password to use to authenticate with the server.

Returns:

The JobService to use to communicate with the server.

Throws:

RemoteException - If a failure occurs in attempting to communicate with the server.

LoginException - If the login attempt fails.

NotBoundException - If the AuthenticationService could not be found at the server.

ProtocolVersionException - If this client is incompatible with the server.

submitJob

public static UUID submitJob(ParallelizableJob job,
                             String description,
                             String host,
                             String username,
                             String password)
                      throws SecurityException,
                             RemoteException,
                             ClassNotFoundException,
                             JobExecutionException,
                             LoginException,
                             NotBoundException,
                             ProtocolVersionException

Submits a job to a server for processing.

Parameters:

job - The ParallelizableJob to be processed.

description - A description of the job.

host - The host name of the server to send the job to.

username - The user name to use to authenticate with the server.

password - The password to use to authenticate with the server.

Returns:

The UUID assigned to the job.

Throws:

SecurityException - If the user does not have access to perform the requested action on the server.

RemoteException - If a failure occurs in attempting to communicate with the server.

ClassNotFoundException - If deserialization of the job at the server requires a class that could not be found on the server.

JobExecutionException - If the submitted job threw an exception at the server during initialization.

LoginException - If the login attempt fails.

NotBoundException - If the AuthenticationService could not be found at the server.

ProtocolVersionException - If this client is incompatible with the server.

registerTaskService

public static void registerTaskService(String name,
                                       TaskService taskService,
                                       String host,
                                       String username,
                                       String password)
                                throws SecurityException,
                                       RemoteException,
                                       ClassNotFoundException,
                                       JobExecutionException,
                                       LoginException,
                                       NotBoundException,
                                       ProtocolVersionException

Connects to a job server and provides a source of tasks to be processed.

Parameters:

name - The name to assign to the TaskService. This may be used to manage this TaskService in later calls.

taskService - The TaskService to submit.

host - The host name of the server to send the job to.

username - The user name to use to authenticate with the server.

password - The password to use to authenticate with the server.

Throws:

SecurityException - If the user does not have access to perform the requested action on the server.

RemoteException - If a failure occurs in attempting to communicate with the server.

ClassNotFoundException - If deserialization of the job at the server requires a class that could not be found on the server.

JobExecutionException - If the submitted job threw an exception at the server during initialization.

LoginException - If the login attempt fails.

NotBoundException - If the AuthenticationService could not be found at the server.

ProtocolVersionException - If this client is incompatible with the server.

getHostService

public static HostService getHostService()

Gets the currently active HostService.

Returns:

The active HostService if the current thread is executing on a job server, null otherwise.

getHomeDirectory

public static File getHomeDirectory()

Gets the folder at which JDCP application data is stored.

Returns:

The File representing the folder at which JDCP application data is stored.

initialize

public static void initialize()

Performs initialization for the currently running JDCP application.