org.globus.exec.client
Class GramJob

java.lang.Object
  org.globus.exec.client.GramJob

All Implemented Interfaces:

NotifyCallback

public class GramJob

extends java.lang.Object

implements NotifyCallback

This class represents a simple gram job. It allows for submitting a job,canceling it, sending a signal command and registering and unregistering job state chang listeners. This class hides the middleware API from the consumer.

Field Summary

private Authorization	authorization
private int	axisStubTimeOut
private static java.lang.String	BASE_SERVICE_PATH
static Authorization	DEFAULT_AUTHZ
static int	DEFAULT_DURATION_HOURS
static java.lang.Integer	DEFAULT_MSG_PROTECTION
private static java.lang.String	DEFAULT_SECURITY_TYPE
static int	DEFAULT_TIMEOUT
private boolean	delegationEnabled
protected org.apache.axis.message.addressing.EndpointReferenceType	delegationFactoryEndpoint
private boolean	destroyed
private java.util.Date	duration
private int	error
private int	exitCode
private org.globus.exec.generated.FaultType	fault
private boolean	holding
private static org.globus.util.I18n	i18n
private java.lang.String	id
private org.globus.exec.generated.JobDescriptionType	jobDescription
private org.apache.axis.message.addressing.EndpointReferenceType	jobEndpointReference
private java.lang.String	jobHandle
private boolean	limitedDelegation
private java.util.Vector	listeners
private static org.apache.commons.logging.Log	logger
private java.lang.Integer	msgProtectionType
private org.apache.axis.message.addressing.EndpointReferenceType	notificationConsumerEPR
private NotificationConsumerManager	notificationConsumerManager
private org.apache.axis.message.addressing.EndpointReferenceType	notificationProducerEPR
private boolean	personal
private static java.lang.String	PERSONAL_SERVICE_PATH
private org.ietf.jgss.GSSCredential	proxy
private java.lang.String	securityType
private static java.lang.String	SERVICE_PATH
protected org.apache.axis.message.addressing.EndpointReferenceType	stagingDelegationFactoryEndpoint
private org.globus.exec.generated.StateEnumeration	state
private java.lang.Object	stateMonitor
private java.util.Date	terminationDate
private boolean	useDefaultNotificationConsumer

Constructor Summary

GramJob()
Creates a gram job with no RSL.

GramJob(java.io.File rslFile)
Creates a gram job with specified file containing the rsl.

GramJob(org.globus.exec.generated.JobDescriptionType jobDescription)
Creates a gram job with specified job description.

GramJob(java.lang.String rsl)
Creates a gram job with specified rsl.

Method Summary

private static void	addDefaultDurationTo(java.util.Calendar currentTime)
void	addListener(GramJobListener listener) Add a listener to the GramJob.
private java.lang.String[]	addPathToArray(java.lang.String[] pathArray, java.lang.String newPath)
void	bind() Registers a callback listener for this job.
void	cancel() Cancels a job.
private java.lang.String	catenate(java.lang.String baseURL, java.lang.String path)
private org.apache.axis.message.addressing.EndpointReferenceType	createJobEndpoint(org.globus.exec.generated.ManagedJobFactoryPortType factoryPort, boolean batch)
private org.apache.axis.message.addressing.EndpointReferenceType	delegate(org.apache.axis.message.addressing.EndpointReferenceType delegationFactoryEndpoint, boolean limitedDelegation)
void	deliver(java.util.List topicPath, org.apache.axis.message.addressing.EndpointReferenceType producer, java.lang.Object message) Deliver the notification message
private org.globus.exec.generated.FaultType	deserializeFaultRP(javax.xml.soap.SOAPElement any)
void	destroy() Precondition: isRequested() Postcondition: isLocallyDestroyed()
private void	destroyDelegatedCredential(org.apache.axis.message.addressing.EndpointReferenceType credentialEndpoint)
private void	destroyDelegatedCredentials()
private void	destroyTransferDelegatedCredential(org.globus.exec.generated.JobDescriptionType jobDescription)
org.apache.axis.message.addressing.EndpointReferenceType[]	fetchDelegationFactoryEndpoints(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint)
Authorization	getAuthorization()
org.ietf.jgss.GSSCredential	getCredentials() Gets the credentials of this job.
private static java.util.Calendar	getDefaultTerminationTime()
java.lang.String	getDelegationLevel()
org.globus.exec.generated.JobDescriptionType	getDescription()
org.apache.axis.message.addressing.EndpointReferenceType	getEndpoint() Precondition: isRequested()
int	getError() Gets the error of the job.
int	getExitCode()
org.globus.exec.generated.FaultType	getFault() Return information about the cause of a job failure (when getStateAsString.equals(StateEnumeration._Failed))
private org.globus.exec.generated.FaultType	getFaultFromRP(org.globus.exec.generated.FaultResourcePropertyType fault)
java.lang.String	getHandle() Can be used instead of #getEndpointReference Precondition: isRequested()
java.lang.String	getID()
static java.util.List	getJobs(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint)
private org.globus.exec.generated.ManagedJobFactoryPortType	getManagedJobFactoryPortType(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint)
java.lang.Integer	getMessageProtectionType()
org.apache.axis.message.addressing.EndpointReferenceType	getNotificationConsumerEPR()
java.lang.String	getSecurityType()
org.globus.exec.generated.StateEnumeration	getState() Get the current state of this job.
private java.util.Calendar	getTerminationTime() get termination time of managed job service based on parameters specified as JavaBean properties on this object.
boolean	isDelegationEnabled()
boolean	isHolding()
boolean	isLocallyDestroyed()
boolean	isMultiJob()
boolean	isPersonal()
boolean	isRequested() Returns true if the job has been requested.
boolean	isSingleJob()
private void	populateJobDescriptionEndpoints(org.apache.axis.message.addressing.EndpointReferenceType mjFactoryEndpoint)
private void	populateStagingDescriptionEndpoints(org.apache.axis.message.addressing.EndpointReferenceType mjFactoryEndpoint, org.apache.axis.message.addressing.EndpointReferenceType delegationFactoryEndpoint, org.globus.exec.generated.JobDescriptionType jobDescription)
void	prependBaseURLtoStageInSources(java.lang.String baseURL)
void	prependBaseURLtoStageOutDestinations(java.lang.String baseURL)
private void	refreshRSLAttributes() Gets submitted RSL from remote Managed Job Service.
void	refreshStatus() Asks the job service for its state,i.e.
void	release()
void	removeListener(GramJobListener listener) Remove a listener from the GramJob.
void	setAuthorization(Authorization authz)
void	setCredentials(org.ietf.jgss.GSSCredential newProxy) Sets credentials of the job
void	setDelegationEnabled(boolean delegationEnabled)
void	setDuration(java.util.Date duration) The default lifetime of the resource is 24 hours.
void	setEndpoint(org.apache.axis.message.addressing.EndpointReferenceType endpoint)
protected void	setError(int code) Sets the error code of the job.
private void	setFault(org.globus.exec.generated.FaultType fault)
void	setHandle(java.lang.String handle) Can be used instead of #setEndpointReference
void	setMessageProtectionType(java.lang.Integer protectionType)
void	setNotificationConsumerEPR(org.apache.axis.message.addressing.EndpointReferenceType notificationConsumerEPR)
void	setPersonal(boolean personal)
void	setSecurityType(java.lang.String securityType)
private void	setSecurityTypeFromEndpoint(org.apache.axis.message.addressing.EndpointReferenceType epr)
void	setServiceTerminationTime() Set TerminationTime RP of managed job service based on parameters specified as JavaBean properties on this object.
private void	setState(org.globus.exec.generated.StateEnumeration state, boolean holding) Sets the state of the job and update the local state listeners.
private void	setStubSecurityProperties(javax.xml.rpc.Stub stub)
void	setTerminationTime(java.util.Date termTime)
void	setTimeOut(int timeout) Set timeout for HTTP socket.
private void	setupNotificationConsumer()
private void	setupNotificationConsumerManager()
void	submit(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint) Submits an interactive i.e.
void	submit(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint, boolean batch) Submits a job with limited delegation.
void	submit(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint, boolean batch, boolean limitedDelegation, java.lang.String jobId)
java.lang.String	toString() Returns string representation of this job.
void	unbind() Unregisters a callback listener for this job.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static org.apache.commons.logging.Log logger

i18n

private static org.globus.util.I18n i18n

DEFAULT_DURATION_HOURS

public static final int DEFAULT_DURATION_HOURS

See Also:

Constant Field Values

DEFAULT_SECURITY_TYPE

private static final java.lang.String DEFAULT_SECURITY_TYPE

See Also:

Constant Field Values

DEFAULT_MSG_PROTECTION

public static final java.lang.Integer DEFAULT_MSG_PROTECTION

DEFAULT_AUTHZ

public static final Authorization DEFAULT_AUTHZ

securityType

private java.lang.String securityType

msgProtectionType

private java.lang.Integer msgProtectionType

authorization

private Authorization authorization

proxy

private org.ietf.jgss.GSSCredential proxy

limitedDelegation

private boolean limitedDelegation

delegationEnabled

private boolean delegationEnabled

personal

private boolean personal

jobDescription

private org.globus.exec.generated.JobDescriptionType jobDescription

jobEndpointReference

private org.apache.axis.message.addressing.EndpointReferenceType jobEndpointReference

jobHandle

private java.lang.String jobHandle

id

private java.lang.String id

fault

private org.globus.exec.generated.FaultType fault

state

private org.globus.exec.generated.StateEnumeration state

stateMonitor

private java.lang.Object stateMonitor

holding

private boolean holding

error

private int error

exitCode

private int exitCode

listeners

private java.util.Vector listeners

destroyed

private boolean destroyed

duration

private java.util.Date duration

terminationDate

private java.util.Date terminationDate

useDefaultNotificationConsumer

private boolean useDefaultNotificationConsumer

notificationConsumerManager

private NotificationConsumerManager notificationConsumerManager

notificationConsumerEPR

private org.apache.axis.message.addressing.EndpointReferenceType notificationConsumerEPR

notificationProducerEPR

private org.apache.axis.message.addressing.EndpointReferenceType notificationProducerEPR

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

axisStubTimeOut

private int axisStubTimeOut

BASE_SERVICE_PATH

private static final java.lang.String BASE_SERVICE_PATH

See Also:

Constant Field Values

SERVICE_PATH

private static final java.lang.String SERVICE_PATH

See Also:

Constant Field Values

PERSONAL_SERVICE_PATH

private static final java.lang.String PERSONAL_SERVICE_PATH

See Also:

Constant Field Values

delegationFactoryEndpoint

protected org.apache.axis.message.addressing.EndpointReferenceType delegationFactoryEndpoint

stagingDelegationFactoryEndpoint

protected org.apache.axis.message.addressing.EndpointReferenceType stagingDelegationFactoryEndpoint

Constructor Detail

GramJob

public GramJob()

Creates a gram job with no RSL. This default constructor is used in conjunction with #setEndpoint().

GramJob

public GramJob(org.globus.exec.generated.JobDescriptionType jobDescription)

Creates a gram job with specified job description.

GramJob

public GramJob(java.io.File rslFile)
        throws org.globus.exec.utils.rsl.RSLParseException,
               java.io.FileNotFoundException

Creates a gram job with specified file containing the rsl. Currently the rsl is required to be in the new XML-based form. For backwords compatibility this should accept the old format, but the conversion algorithm isn't in place yet.

Parameters:

rslFile - file with job specification

GramJob

public GramJob(java.lang.String rsl)
        throws org.globus.exec.utils.rsl.RSLParseException

Creates a gram job with specified rsl. Currently the rsl is required to be in the new XML-based form. For backwords compatibility this should accept the old format, but the conversion algorithm isn't in place yet.

Parameters:

rsl - resource specification string

Method Detail

addListener

public void addListener(GramJobListener listener)

Add a listener to the GramJob. The listener will be notified whenever the state of the GramJob changes.

Parameters:

listener - The object that wishes to receive state updates.

See Also:

org.globus.gram.GramJobListener

removeListener

public void removeListener(GramJobListener listener)

Remove a listener from the GramJob. The listener will no longer be notified of state changes for the GramJob.

Parameters:

listener - The object that wishes to stop receiving state updates.

See Also:

org.globus.gram.GramJobListener

getCredentials

public org.ietf.jgss.GSSCredential getCredentials()

Gets the credentials of this job.

Returns:

job credentials. If null none were set.

setCredentials

public void setCredentials(org.ietf.jgss.GSSCredential newProxy)

Sets credentials of the job

Parameters:

newProxy - user credentials

Throws:

java.lang.IllegalArgumentException - if credentials are already set

getState

public org.globus.exec.generated.StateEnumeration getState()

Get the current state of this job.

Returns:

current job state

setState

private void setState(org.globus.exec.generated.StateEnumeration state,
                      boolean holding)

Sets the state of the job and update the local state listeners. Users should not call this function. Preconditionstate != null

Parameters:

state - state of the job

isHolding

public boolean isHolding()

submit

public void submit(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint)
            throws java.lang.Exception

Submits an interactive i.e. non-batch job with limited delegation

Throws:

java.lang.Exception

See Also:

for explanation of parameters

submit

public void submit(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint,
                   boolean batch)
            throws java.lang.Exception

Submits a job with limited delegation.

Throws:

java.lang.Exception

See Also:

for explanation of parameters

submit

public void submit(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint,
                   boolean batch,
                   boolean limitedDelegation,
                   java.lang.String jobId)
            throws java.lang.Exception

Parameters:

factoryEndpoint - the resource manager service endpoint. The service address can be specified in the following ways:
host
host:port
host:port/service
host/service
host:/service
host::subject
host:port:subject
host/service:subject
host:/service:subject
host:port/service:subject

batch - specifies if the job should be submitted as a batch job.

limitedDelegation - true for limited delegation, false for full delegation.

jobId - For reliable service instance creation, use the specified jobId to allow repeated, reliable attempts to submit the job submission in the presence of an unreliable transport.

Throws:

java.lang.Exception

See Also:

for detailed resource manager contact specification.

setSecurityTypeFromEndpoint

private void setSecurityTypeFromEndpoint(org.apache.axis.message.addressing.EndpointReferenceType epr)

populateJobDescriptionEndpoints

private void populateJobDescriptionEndpoints(org.apache.axis.message.addressing.EndpointReferenceType mjFactoryEndpoint)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

populateStagingDescriptionEndpoints

private void populateStagingDescriptionEndpoints(org.apache.axis.message.addressing.EndpointReferenceType mjFactoryEndpoint,
                                                 org.apache.axis.message.addressing.EndpointReferenceType delegationFactoryEndpoint,
                                                 org.globus.exec.generated.JobDescriptionType jobDescription)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

fetchDelegationFactoryEndpoints

public org.apache.axis.message.addressing.EndpointReferenceType[] fetchDelegationFactoryEndpoints(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint)
                                                                                           throws java.lang.Exception

Throws:

java.lang.Exception

delegate

private org.apache.axis.message.addressing.EndpointReferenceType delegate(org.apache.axis.message.addressing.EndpointReferenceType delegationFactoryEndpoint,
                                                                          boolean limitedDelegation)
                                                                   throws java.lang.Exception

Throws:

java.lang.Exception

addPathToArray

private java.lang.String[] addPathToArray(java.lang.String[] pathArray,
                                          java.lang.String newPath)

Parameters:

pathArray - String[] old

newPath - String

Returns:

String[] new path array

catenate

private java.lang.String catenate(java.lang.String baseURL,
                                  java.lang.String path)

prependBaseURLtoStageInSources

public void prependBaseURLtoStageInSources(java.lang.String baseURL)

prependBaseURLtoStageOutDestinations

public void prependBaseURLtoStageOutDestinations(java.lang.String baseURL)

getDescription

public org.globus.exec.generated.JobDescriptionType getDescription()
                                                            throws java.lang.Exception

Returns:

the job description

Throws:

java.lang.Exception

createJobEndpoint

private org.apache.axis.message.addressing.EndpointReferenceType createJobEndpoint(org.globus.exec.generated.ManagedJobFactoryPortType factoryPort,
                                                                                   boolean batch)
                                                                            throws java.lang.Exception

Throws:

java.lang.Exception

setupNotificationConsumerManager

private void setupNotificationConsumerManager()
                                       throws org.ietf.jgss.GSSException,
                                              ContainerException

Throws:

org.ietf.jgss.GSSException

ContainerException

setupNotificationConsumer

private void setupNotificationConsumer()
                                throws SecurityDescriptorException,
                                       ResourceException

Throws:

SecurityDescriptorException

ResourceException

isRequested

public boolean isRequested()

Returns true if the job has been requested. Useful to determine if destroy() can be called when it is not obvious.

setPersonal

public void setPersonal(boolean personal)

isPersonal

public boolean isPersonal()

getManagedJobFactoryPortType

private org.globus.exec.generated.ManagedJobFactoryPortType getManagedJobFactoryPortType(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint)
                                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

cancel

public void cancel()
            throws java.lang.Exception

Cancels a job.

Throws:

java.lang.Exception

bind

public void bind()
          throws java.lang.Exception

Registers a callback listener for this job. (Reconnects to the job) Precondition this.jobEndpointReference != null

Throws:

GramException - if error occurs during job registration.

org.ietf.jgss.GSSException - if user credentials are invalid.

java.lang.Exception

unbind

public void unbind()
            throws NoSuchResourceException,
                   java.lang.Exception

Unregisters a callback listener for this job. (disconnects from the job) Precondition ClientNotificationConsumer.isListening()

Throws:

NoSuchResourceException

java.lang.Exception

destroy

public void destroy()
             throws java.lang.Exception

Precondition: isRequested() Postcondition: isLocallyDestroyed()

Throws:

GramException - if error occurs during job service destruction.

java.lang.Exception

destroyDelegatedCredentials

private void destroyDelegatedCredentials()
                                  throws java.lang.Exception

Throws:

java.lang.Exception

destroyTransferDelegatedCredential

private void destroyTransferDelegatedCredential(org.globus.exec.generated.JobDescriptionType jobDescription)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

destroyDelegatedCredential

private void destroyDelegatedCredential(org.apache.axis.message.addressing.EndpointReferenceType credentialEndpoint)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isLocallyDestroyed

public boolean isLocallyDestroyed()

Returns:

boolean true if #destroy() destroy() has been called

release

public void release()
             throws java.lang.Exception

Throws:

java.lang.Exception

setError

protected void setError(int code)

Sets the error code of the job. Note: User should not use this method.

Parameters:

code - error code

getError

public int getError()

Gets the error of the job.

Returns:

error number of the job.

getFault

public org.globus.exec.generated.FaultType getFault()

Return information about the cause of a job failure (when getStateAsString.equals(StateEnumeration._Failed))

getEndpoint

public org.apache.axis.message.addressing.EndpointReferenceType getEndpoint()

Precondition: isRequested()

setEndpoint

public void setEndpoint(org.apache.axis.message.addressing.EndpointReferenceType endpoint)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getID

public java.lang.String getID()

getHandle

public java.lang.String getHandle()

Can be used instead of #getEndpointReference Precondition: isRequested()

setHandle

public void setHandle(java.lang.String handle)
               throws java.lang.Exception

Can be used instead of #setEndpointReference

Throws:

java.lang.Exception

getExitCode

public int getExitCode()

setTimeOut

public void setTimeOut(int timeout)

Set timeout for HTTP socket. Default is 120000 (2 minutes).

Parameters:

timeout - the timeout value, in milliseconds.

toString

public java.lang.String toString()

Returns string representation of this job.

Returns:

string representation of this job. Useful for debugging.

deliver

public void deliver(java.util.List topicPath,
                    org.apache.axis.message.addressing.EndpointReferenceType producer,
                    java.lang.Object message)

Deliver the notification message

Specified by:

deliver in interface NotifyCallback

Parameters:

topicPath - The topic path for the topic that generated the notification

producer - The producer endpoint reference

message - The notification message

setFault

private void setFault(org.globus.exec.generated.FaultType fault)
               throws java.lang.Exception

Throws:

java.lang.Exception

getFaultFromRP

private org.globus.exec.generated.FaultType getFaultFromRP(org.globus.exec.generated.FaultResourcePropertyType fault)

deserializeFaultRP

private org.globus.exec.generated.FaultType deserializeFaultRP(javax.xml.soap.SOAPElement any)
                                                        throws DeserializationException

Throws:

DeserializationException

refreshStatus

public void refreshStatus()
                   throws java.lang.Exception

Asks the job service for its state,i.e. its state and the cause if the state is 'Failed'. This is useful when subscribing to notifications is impossible but an immediate result is needed. Preconditionjob has been submitted

Throws:

java.lang.Exception - if the service data cannot be fetched or the job state not extracted from the data.

refreshRSLAttributes

private void refreshRSLAttributes()
                           throws java.lang.Exception

Gets submitted RSL from remote Managed Job Service. It is actually not only the final, but substituted RSL. To obtain it call getRSLAttributes afterwards. Preconditionjob has been submitted

Throws:

java.lang.Exception

getJobs

public static java.util.List getJobs(org.apache.axis.message.addressing.EndpointReferenceType factoryEndpoint)
                              throws java.lang.Exception

Throws:

java.lang.Exception

setStubSecurityProperties

private void setStubSecurityProperties(javax.xml.rpc.Stub stub)

setAuthorization

public void setAuthorization(Authorization authz)

getAuthorization

public Authorization getAuthorization()

setSecurityType

public void setSecurityType(java.lang.String securityType)

getSecurityType

public java.lang.String getSecurityType()

setMessageProtectionType

public void setMessageProtectionType(java.lang.Integer protectionType)

getMessageProtectionType

public java.lang.Integer getMessageProtectionType()

getDelegationLevel

public java.lang.String getDelegationLevel()

setDelegationEnabled

public void setDelegationEnabled(boolean delegationEnabled)

isDelegationEnabled

public boolean isDelegationEnabled()

setDuration

public void setDuration(java.util.Date duration)

The default lifetime of the resource is 24 hours.

Parameters:

duration - the duration after which the job service should be destroyed. The hours and minutes will be used.

setTerminationTime

public void setTerminationTime(java.util.Date termTime)

getTerminationTime

private java.util.Calendar getTerminationTime()
                                       throws java.lang.Exception

get termination time of managed job service based on parameters specified as JavaBean properties on this object. Preconditionjob has been requested

Returns:

Calendar

Throws:

java.lang.Exception

setServiceTerminationTime

public void setServiceTerminationTime()
                               throws java.lang.Exception

Set TerminationTime RP of managed job service based on parameters specified as JavaBean properties on this object. Preconditionjob has been requested

Returns:

Calendar

Throws:

java.lang.Exception

addDefaultDurationTo

private static void addDefaultDurationTo(java.util.Calendar currentTime)

getDefaultTerminationTime

private static java.util.Calendar getDefaultTerminationTime()

isSingleJob

public boolean isSingleJob()

isMultiJob

public boolean isMultiJob()

getNotificationConsumerEPR

public org.apache.axis.message.addressing.EndpointReferenceType getNotificationConsumerEPR()

setNotificationConsumerEPR

public void setNotificationConsumerEPR(org.apache.axis.message.addressing.EndpointReferenceType notificationConsumerEPR)