Definition of WebService interface for job submitting
GrmsResponse submitJob(String jobDefinition, String jobId)
Input Parameters:
- String jobDefinition - XML document describing job to be submitted
Output Parameters:
- String JobId -> unique Job ID
Return Value:
- GrmsResponse.errorCode
0 - success
>0 - error code
Definition of WebService interface for job migration
GrmsResponse migrateJob(String jobId, String jobDefinition)
Input Parameters:
- String jobId - id of job to be migrated
- String jobDefinition - XML document describing migration
Output Parameters:
-
Return Value:
- GrmsResponse.errorCode
0 - success
>0 - error code
Definition of WebService interface for job migration
GrmsResponse migrateJob(String jobId)
Input Parameters:
- String jobId - id of job to be migrated
Output Parameters:
-
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for job suspending
GrmsResponse suspendJob(String jobId, String jobDefinition)
Input Parameters:
- String jobId - id of job to be suspended
- String jobDefinition - XML document describing migration
Output Parameters:
-
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for job suspending
int suspendJob(String jobId)
Input Parameters:
- String jobId - id of job to be suspended
Output Parameters:
-
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for job resuming
GrmsResponse resumeJob(String jobId, String jobDefinition)
Input Parameters:
- String jobId - id of job to be migrated
- String jobDefinition - XML document describing resumed
Output Parameters:
-
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for job resumeing
GrmsResponse resumeJob(String jobId)
Input Parameters:
- String jobId - id of job to be resumed
Output Parameters:
-
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for obtaining list of jobs belonging to the user
GrmsResponse getJobsList(String[] jobsList)
Input Parameters:
-
Output Parameters:
- String[] - array of job IDs belonging to the user
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for obtaining list of jobs in given state belonging to the user
int getJobsList(enum JobStatusType status, String[] jobsList)
Input Parameters:
- enum JobStatusType status - status of the job
Output Parameters:
- String[] - array of job IDs belonging to the user
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for obtaining list of jobs belonging to the given project
GrmsResponse getProjectJobsList(String project, String[] jobsList)
Input Parameters:
- String project - name of the project
Output Parameters:
- String[] - array of job IDs belonging to the user
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for obtaining list of jobs in given state belonging to the given project
int getProjectJobsList(enum JobStatusType status, String[] jobsList)
Input Parameters:
- String project - name of the project
- enum JobStatusType status - status of the job
Output Parameters:
- String[] - array of job IDs belonging to the user
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for registering application access
GrmsResponse registerApplicationAccess(String jobId, String service_location, int pid)
Input Parameters:
- String jobId - job identifier
- String service_location - location of the application/service
- int pod - ProcessID
Output Parameters:
-
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for unregistering application access
GrmsResponse unregisterApplicationAccess( String jobId)
Input Parameters:
- String jobId - job identifier
Output Parameters:
-
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for getting application access
GrmsResponse getApplicationAccess(String jobId, String service_location, int pid)
Input Parameters:
- String jobId - job identifier
Output Parameters:
- String service_location - location of the application/service
- int pod - ProcessID
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for testing the description of the job
GrmsResponse testJobDescription(String jobId)
Input Parameters:
- String jobId - job identifier
Output Parameters:
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for getting the information of job
GrmsResponse getJobInfo(String jobId, jobInformation jobInfo)
Input Parameters:
- String jobId - job identifier
Output Parameters:
- jobInformation jobInfo - information about the job
jobInformation
{
String userDn;
enum JobStatusType jobStatus;
Calendar submitionTime;
Calendar finishTime;
String requestStatus;
int reqNumStatus;
String errorDescription;
jobHistory history;
}
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for getting the history of job
GrmsResponse getJobHistory(String jobId, jobHistory[] history)
Input Parameters:
- String jobId - job identifier
Output Parameters:
- jobHistory[] history - information about the history
jobHistory
{
String hostName;
Calendar startTime;
Calendar localStartTime;
Calendar localFinishTime;
String jobDescription;
}
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for finding resources
GrmsResponse findResources( String resourceDefinition, String[] resources)
Input Parameters:
- String resourceDefinition - XML document describing resource preferences
Output Parameters:
- String[] resources -> array of resources (resourceManagerContact) that match user preferences
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for canceling a job
GrmsResponse cancelJob( String jobId)
Input Parameters:
- String jobId - job identifier
Output Parameters:
-
Return Value:
- GrmsResponse:
0 - success
>0 - error code
Definition of WebService interface for getting the description of the service
String getServiceDescription( DescriptionType description)
Input Parameters:
- DescriptionType type - type of the description (enum SHORT, FULL)
Output Parameters:
-
Return Value:
- String - containing the description of the service
Definition of WebService interface for obtaining list of all jobs in given state
GrmsResponse getJobsList(enum JobStatusType status, String[] jobsList)
Input Parameters:
- enum JobStatusType status
Output Parameters:
- String[] - array of job IDs belonging to the user
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for registering listner for notifications
GrmsResponse registerNotification(String jobId, NotificationRequest request, String notificationId)
Input Parameters:
- String jobId - job identifier
- NotificationRequest request:
- enum eventType = {STATUS, REQUEST}
- enum protocol = {SOAP, GASS}
- String destination - url of service waiting for notifications
- bool append - in case of GASS notification defines in event should be append to the file or overwrite it
- String format - in case of GASS notification specifies format of message
Output Parameters:
- String notificationId - identifier of the notification
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for list of registered notifications
GrmsResponse getrNotificationsList(String jobId, String[] notificationIds)
Input Parameters:
- String jobId - job identifier
Output Parameters:
- String[] notificationIds - list of registered notifications
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for unregistering listner for notifications
GrmsResponse unregisterNotification( String jobId String notificationId)
Input Parameters:
- String notificationId - identifier of the notification
Output Parameters:
-
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for getting information about registered notification
GrmsResponse getNotificationInformation(String jobId, String notificationId, NotificationRequest request)
Input Parameters:
- String jobId - job identifier
- String notificationId - notification identifier
Output Parameters:
- NotificationRequest request:
- enum eventType = {STATUS, REQUEST}
- enum protocol = {SOAP, GASS}
- String destination - url of service waiting for notifications
- bool append - in case of GASS notification defines in event should be append to the file or overwrite it
- String format - in case of GASS notification specifies format of message
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for registering new output files/directories
GrmsResponse AddOutputFileDirs( String jobId, FileDir[] items, OUT int errors, OUT int[] result)
Input Parameters:
- String jobId - job identifier
- FileDir[] items - files/directories to be added
FileDir:
- String name - name of the file
- String path - path of the file
- enum UrlType urlType = {PHISICAL, LOGICAL}
- enum PathType pathType = {FILE, DIRECTORY}
Output Parameters:
- int errors - number of errors in 'result' array
- int[] result - results of operation (for each item)
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for getting registered output files/directories
GrmsResponse getOutputFileDirs( String jobId, OUT FileDir[] items)
Input Parameters:
Output Parameters:
- String jobId - job identifier
- FileDir[] items - registered output files/directories
For definition of FileDir see AddOutFileDir operation
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for unregistering output files/directories
GrmsResponse DeleteOutputFileDirs( String jobId, FileDir[] items, OUT int errors, OUT int[] result)
For definition of FileDir see AddOutFileDir operation.
Input Parameters:
- String jobId - job identifier
- FileDir[] items - files/directories to be added
Output Parameters:
- int errors - number of errors in 'result' array
- int[] result - results of operation (for each item)
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for registering new checkpoint files/directories
GrmsResponse AddCheckpointFileDirs( String jobId, FileDir[] items, OUT int errors, OUT int[] result)
Input Parameters:
- String jobId - job identifier
- FileDir[] items - files/directories to be added
For definition of FileDir see the AddOutFIleDirs operation
Output Parameters:
- int errors - number of errors in 'result' array
- int[] result - results of operation (for each item)
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for getting registered checkpoint files/directories
GrmsResponse getCheckpointFileDirs( String jobId, OUT FileDir[] items)
Input Parameters:
Output Parameters:
- String jobId - job identifier
- FileDir[] items - registered output files/directories
For definition of FileDir see AddOutFileDir operation
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code
Definition of WebService interface for unregistering checkpoint files/directories
GrmsResponse DeleteCheckpointFileDirs( String jobId, FileDir[] items, OUT int, OUT int[] result)
For definition of FileDir see AddOutFileDir operation.
Input Parameters:
- String jobId - job identifier
- FileDir[] items - files/directories to be added
Output Parameters:
- int errors - number of errors in 'result' array
- int[] result - results of operation (for each item)
Return Value:
- GrmsResponse.errorCode:
0 - success
>0 - error code