com.intel.gpe.clients.api
Interface JobClient

All Superinterfaces:
ServiceClient, WSLTClient, WSRFClient, WSRPClient
All Known Subinterfaces:
GridletJobClient, LoggingJobClient, WorkflowJobClient

public interface JobClient
extends WSLTClient

The client interface to manage the job management resource.

Version:
$Id: JobClient.java,v 1.10 2006/04/11 08:58:52 lukichev Exp $
Author:
Alexander Lukichev, Ralf Ratering

Method Summary
 void abort()
          Abort the job.
<JobDefinitionType extends Job>
JobDefinitionType
getExecutionJSDL()
           
<JobDefinitionType extends Job>
JobDefinitionType
getOriginalJSDL()
           
<StatysType extends Status>
Status
getStatus()
           
 java.util.Calendar getSubmissionTime()
           
<TargetSystemClientType extends TargetSystemClient>
TargetSystemClientType
getTargetSystem()
           
<StorageClientType extends StorageClient>
StorageClientType
getWorkingDirectory()
           
 void hold()
          Hold (suspend) the job.
 void resume()
          Resume the suspended job.
 void start()
          Start the job.
 
Methods inherited from interface com.intel.gpe.clients.api.WSLTClient
destroy, getCurrentTime, getTerminationTime, setTerminationTime
 
Methods inherited from interface com.intel.gpe.clients.api.WSRPClient
getMultipleResourceProperties, getResourceProperty, getResourcePropertyDocument, queryXPath10Properties
 

Method Detail

start

void start()
           throws GPEJobNotStartedException,
                  GPEResourceUnknownException,
                  GPEMiddlewareRemoteException,
                  GPEMiddlewareServiceException,
                  GPESecurityException
Start the job.

Throws:
GPEJobNotStartedException - If job failed to start
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPESecurityException - If client fails to setup security
GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException
GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getStatus

<StatysType extends Status> Status getStatus()
                 throws GPEInvalidResourcePropertyQNameException,
                        GPEResourceUnknownException,
                        GPEUnmarshallingException,
                        GPESecurityException,
                        GPEMiddlewareRemoteException,
                        GPEMiddlewareServiceException
Returns:
The status of the job
Throws:
GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide Status property
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object
GPESecurityException - If client fails to setup security
GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException
GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getOriginalJSDL

<JobDefinitionType extends Job> JobDefinitionType getOriginalJSDL()
                                              throws GPEInvalidResourcePropertyQNameException,
                                                     GPEResourceUnknownException,
                                                     GPEUnmarshallingException,
                                                     GPESecurityException,
                                                     GPEMiddlewareRemoteException,
                                                     GPEMiddlewareServiceException
Returns:
The value of jms:OriginalJSDL resource property
Throws:
GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide OriginalJSDL property
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object
GPESecurityException - If client fails to setup security
GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException
GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getExecutionJSDL

<JobDefinitionType extends Job> JobDefinitionType getExecutionJSDL()
                                               throws GPEInvalidResourcePropertyQNameException,
                                                      GPEResourceUnknownException,
                                                      GPEUnmarshallingException,
                                                      GPESecurityException,
                                                      GPEMiddlewareRemoteException,
                                                      GPEMiddlewareServiceException
Returns:
The value of jms:ExecutionJSDL resource property
Throws:
GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide ExecutionJSDL property
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object
GPESecurityException - If client fails to setup security
GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException
GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getTargetSystem

<TargetSystemClientType extends TargetSystemClient> TargetSystemClientType getTargetSystem()
                                                                  throws GPEInvalidResourcePropertyQNameException,
                                                                         GPEResourceUnknownException,
                                                                         GPEUnmarshallingException,
                                                                         GPESecurityException,
                                                                         GPEMiddlewareRemoteException,
                                                                         GPEMiddlewareServiceException
Returns:
The target system the job is running on
Throws:
GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide TargetSystem property
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object
GPESecurityException - If client fails to setup security
GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException
GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

abort

void abort()
           throws GPEMiddlewareServiceException,
                  GPESecurityException,
                  GPEResourceUnknownException,
                  GPEJobNotAbortedException,
                  GPEMiddlewareRemoteException
Abort the job.

Throws:
GPEJobNotAbortedException - If job failed to abort
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPESecurityException - If client fails to setup security
GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException
GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

hold

void hold()
          throws GPEMiddlewareServiceException,
                 GPESecurityException,
                 GPEJobNotHeldException,
                 GPEResourceUnknownException,
                 GPEMiddlewareRemoteException
Hold (suspend) the job.

Throws:
GPEJobNotHeldException - If job failed to held
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPESecurityException - If client fails to setup security
GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException
GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

resume

void resume()
            throws GPEMiddlewareServiceException,
                   GPESecurityException,
                   GPEResourceUnknownException,
                   GPEJobNotResumedException,
                   GPEMiddlewareRemoteException
Resume the suspended job.

Throws:
GPEJobNotResumedException - If job failed to resume
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPESecurityException - If client fails to setup security
GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException
GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getWorkingDirectory

<StorageClientType extends StorageClient> StorageClientType getWorkingDirectory()
                                                            throws GPEInvalidResourcePropertyQNameException,
                                                                   GPEResourceUnknownException,
                                                                   GPEUnmarshallingException,
                                                                   GPESecurityException,
                                                                   GPEMiddlewareRemoteException,
                                                                   GPEMiddlewareServiceException
Returns:
The storage resource client representing the working directory of the job
Throws:
GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide WorkingDirectory property
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object
GPESecurityException - If client fails to setup security
GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException
GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getSubmissionTime

java.util.Calendar getSubmissionTime()
                                     throws GPEResourceUnknownException,
                                            GPEInvalidResourcePropertyQNameException,
                                            GPESecurityException,
                                            GPEUnmarshallingException,
                                            GPEMiddlewareRemoteException,
                                            GPEMiddlewareServiceException
Returns:
The submission time value
Throws:
GPESecurityException - If client fails to setup security
GPEInvalidResourcePropertyQNameException - If resource does not provide TerminationTime property
GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier
GPEUnmarshallingException
GPEMiddlewareRemoteException
GPEMiddlewareServiceException


Copyright © 2008. All Rights Reserved.