|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.glite.wms.wmproxy.WMProxyAPI
Allows sending requests to the Workload Manager Proxy (WMProxy) server
The class WMProxyAPI represents a client API to access to the WMProxy services provided as Web Services.
It provides a set of methods that allow :
Job requirements are expressed by Job Description Language (JDL). The types of jobs supported by the WM service are:
Constructor Summary | |
WMProxyAPI(java.lang.String url,
java.lang.String proxyFile)
Constructor |
|
WMProxyAPI(java.lang.String url,
java.lang.String proxyFile,
java.lang.String certsPath)
Constructor that allows setting of the Log4j tool by configuration file |
Method Summary | |
void |
enableFilePerusal(java.lang.String jobId,
org.glite.wms.wmproxy.StringList fileList)
Enables file perusal functionalities if not disabled with the specific jdl attribute during job register operation. |
java.lang.String |
getCollectionTemplate(int jobNumber,
java.lang.String requirements,
java.lang.String rank)
Returns a JDL template for a collection of jobs, that is a set of independent jobs that can be submitted, controlled and monitored as a single entity. |
java.lang.String |
getDAGTemplate(org.glite.wms.wmproxy.GraphStructType dependencies,
java.lang.String requirements,
java.lang.String rank)
Returns a JDL template for a DAG. |
void |
getFreeQuota(javax.xml.rpc.holders.LongHolder softLimit,
javax.xml.rpc.holders.LongHolder hardLimit)
Returns the remaining free part of available user disk quota (in bytes). |
java.lang.String |
getIntParametricJobTemplate(org.glite.wms.wmproxy.StringList attributes,
int param,
int parameterStart,
int parameterStep,
java.lang.String requirements,
java.lang.String rank)
Returns a JDL template for a parametric of job, which is a job having one or more parametric attributes in the JDL. |
java.lang.String |
getJobTemplate(org.glite.wms.wmproxy.JobTypeList jobType,
java.lang.String executable,
java.lang.String arguments,
java.lang.String requirements,
java.lang.String rank)
Returns a JDL template for the requested job type. |
double |
getMaxInputSandboxSize()
Returns the maximum Input sandbox size (in bytes) a user can count on for a job submission if using the space managed by the WM. |
org.glite.wms.wmproxy.StringAndLongList |
getOutputFileList(java.lang.String jobId)
Returns the list of URIs where the output files created during job execution have been stored in the WM managed space and the corresponding sizes in bytes. |
org.glite.wms.wmproxy.StringList |
getPerusalFiles(java.lang.String jobId,
java.lang.String file,
boolean allchunks)
Gets the URIs of perusal files generated during job execution for the specified file file. |
java.lang.String |
getProxyReq(java.lang.String delegationId)
Gets a proxy identified by the delegationId string. |
org.glite.wms.wmproxy.DestURIsStructType |
getSandboxBulkDestURI(java.lang.String jobId)
Returns the list of destination URIs associated to a compound job (i.e. |
org.glite.wms.wmproxy.StringList |
getSandboxDestURI(java.lang.String jobId)
Returns a list of destination URI's associated to the job, identified by the jobId provided as input, where the job input sandbox files can be uploaded by the client. |
java.lang.String |
getStringParametricJobTemplate(org.glite.wms.wmproxy.StringList attributes,
org.glite.wms.wmproxy.StringList param,
java.lang.String requirements,
java.lang.String rank)
Returns a JDL template for a parametric of job, which is a job having one or more parametric attributes in the JDL. |
void |
getTotalQuota(javax.xml.rpc.holders.LongHolder softLimit,
javax.xml.rpc.holders.LongHolder hardLimit)
Returns the total space quota assigned to the user on the storage managed by the WM The fault GetQuotaManagementFault is returned if the quota management is not active on the WM. |
java.lang.String |
getVersion()
Gets the version numbers of the WMProxy services |
java.lang.String |
grstGetProxyReq(java.lang.String delegationId)
Gets a proxy identified by the delegationId string. |
void |
grstPutProxy(java.lang.String delegationId,
java.lang.String cert)
This method allows delegating user credential to the WMProxy server using the GridSite package: it creates a proxy from the input certificate (got by a previous call to the createProxyfromCertReq server). |
void |
jobCancel(java.lang.String jobId)
This operation cancels a previously submitted job identified by its JobId. |
org.glite.wms.wmproxy.StringAndLongList |
jobListMatch(java.lang.String jdl,
java.lang.String delegationId)
Returns the list of CE Ids satisfying the job Requirements specified in the JDL, ordered according to the decreasing Rank. |
void |
jobPurge(java.lang.String jobId)
Removes from the WM managed space all files related to the job identified by the jobId provided as input. |
org.glite.wms.wmproxy.JobIdStructType |
jobRegister(java.lang.String jdl,
java.lang.String delegationId)
Registers a job for submission.The unique identifier assigned to the job is returned to the client. |
void |
jobStart(java.lang.String jobId)
Triggers the submission a previously registered job. |
org.glite.wms.wmproxy.JobIdStructType |
jobSubmit(java.lang.String jdl,
java.lang.String delegationId)
Submits a job: performs registration and triggers the submission The JDL description of the job provided by the client is validated by the service, registered to the LB and finally passed to the Workload Manager. |
void |
putProxy(java.lang.String delegationId,
java.lang.String cert)
This method allows delegating user credential to the WMProxy server: it creates a proxy from the input certificate (got by a previous call to the createProxyfromCertReq server). |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public WMProxyAPI(java.lang.String url, java.lang.String proxyFile) throws ServiceException, ServiceURLException, CredentialException
url
- WMProxy service URLproxyFile
- the path location of the user proxy file
ServiceException
- If any error in calling the service
ServiceURLException
- malformed service URL specified as input
CredentialException
- in case of any error with the user proxy filepublic WMProxyAPI(java.lang.String url, java.lang.String proxyFile, java.lang.String certsPath) throws ServiceException, ServiceURLException, CredentialException
url
- WMProxy service URLproxyFile
- the path location of the user proxy file
ServiceException
- If any error occurs in calling the service
CredentialException
- in case of any error with the user proxy file
ServiceURLException
- malformed service URL specified as inputMethod Detail |
public java.lang.String getProxyReq(java.lang.String delegationId) throws AuthenticationFaultException, ServerOverloadedFaultException, AuthorizationFaultException, ServiceException
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
ServiceException
- a problem occurred during the remote call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic java.lang.String grstGetProxyReq(java.lang.String delegationId) throws CredentialException, ServerOverloadedFaultException, ServiceException
CredentialException
- a problem occurred during the operations of retrieving the proxy
ServiceException
- a problem occurred during the remote call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic void putProxy(java.lang.String delegationId, java.lang.String cert) throws AuthenticationFaultException, AuthorizationFaultException, CredentialException, ServerOverloadedFaultException, ServiceException
delegationId
- the id used to identify the delegationcert
- the input certificate
CredentialException
- if any error occurs during the creation of the proxy from the input certificate
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationgetVersion()
public void grstPutProxy(java.lang.String delegationId, java.lang.String cert) throws CredentialException, ServerOverloadedFaultException, ServiceException
delegationId
- the id used to identify the delegationcert
- the input certificate
CredentialException
- a problem occurred during the operations of delegation
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationgetVersion()
public java.lang.String getVersion() throws AuthenticationFaultException, ServerOverloadedFaultException, ServiceException
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic org.glite.wms.wmproxy.JobIdStructType jobRegister(java.lang.String jdl, java.lang.String delegationId) throws AuthenticationFaultException, InvalidArgumentFaultException, ServerOverloadedFaultException, ServiceException
jdl
- the job jdl representation.delegationId
- the id used to identify the delegation
ServerOverloadedFaultException
- the server is too much busy to attend the requested operation
AuthenticationFaultException
- a generic authentication problem occurred
InvalidArgumentFaultException
- the given JDL expression is not valid
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy serverpublic void jobStart(java.lang.String jobId) throws AuthorizationFaultException, AuthenticationFaultException, OperationNotAllowedFaultException, InvalidArgumentFaultException, JobUnknownFaultException, ServerOverloadedFaultException, ServiceException
jobId
- the id of the job
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
JobUnknownFaultException
- the given job has not been registered to the system
InvalidArgumentFaultException
- the given job Id is not valid
OperationNotAllowedFaultException
- the current job status does not allow requested operation.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic org.glite.wms.wmproxy.JobIdStructType jobSubmit(java.lang.String jdl, java.lang.String delegationId) throws AuthorizationFaultException, AuthenticationFaultException, InvalidArgumentFaultException, ServerOverloadedFaultException, ServiceException
delegationId
- the id used to identify the delegation
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
InvalidArgumentFaultException
- the given job Id is not valid
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic void jobCancel(java.lang.String jobId) throws AuthorizationFaultException, AuthenticationFaultException, OperationNotAllowedFaultException, InvalidArgumentFaultException, JobUnknownFaultException, ServerOverloadedFaultException, ServiceException
jobId
- the id of the job
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
JobUnknownFaultException
- the given job has not been registered to the system
InvalidArgumentFaultException
- the given job Id is not valid
OperationNotAllowedFaultException
- the current job status does not allow requested operation.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic double getMaxInputSandboxSize() throws AuthenticationFaultException, ServerOverloadedFaultException, ServiceException
AuthenticationFaultException
- a generic authentication problem occurred
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic org.glite.wms.wmproxy.StringList getSandboxDestURI(java.lang.String jobId) throws AuthorizationFaultException, AuthenticationFaultException, OperationNotAllowedFaultException, InvalidArgumentFaultException, JobUnknownFaultException, ServerOverloadedFaultException, ServiceException
jobId
- string containing the JobId
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
JobUnknownFaultException
- the given job has not been registered to the system
InvalidArgumentFaultException
- the given job Id is not valid
OperationNotAllowedFaultException
- the current job status does not allow requested operation.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic org.glite.wms.wmproxy.DestURIsStructType getSandboxBulkDestURI(java.lang.String jobId) throws AuthorizationFaultException, AuthenticationFaultException, OperationNotAllowedFaultException, InvalidArgumentFaultException, JobUnknownFaultException, ServerOverloadedFaultException, ServiceException
jobId
- string containing the JobId
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
JobUnknownFaultException
- the given job has not been registered to the system
InvalidArgumentFaultException
- the given job Id is not valid
OperationNotAllowedFaultException
- the current job status does not allow requested operation.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic void getTotalQuota(javax.xml.rpc.holders.LongHolder softLimit, javax.xml.rpc.holders.LongHolder hardLimit) throws AuthenticationFaultException, GetQuotaManagementFaultException, ServerOverloadedFaultException, ServiceException
softLimit
- the returned value of the soft limit free quota i.e. the difference between quota soft limit and user's disk usage.hardLimit
- the returned value of the hard limit quota (in bytes) i.e. the real quota limit that cannot be exceeded.
AuthenticationFaultException
- a generic authentication problem occurred
GetQuotaManagementFaultException
- quota management is not active on the WM.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic void getFreeQuota(javax.xml.rpc.holders.LongHolder softLimit, javax.xml.rpc.holders.LongHolder hardLimit) throws AuthenticationFaultException, GetQuotaManagementFaultException, ServerOverloadedFaultException, ServiceException
softLimit
- the returned value of the soft limit free quota i.e. the difference between quota soft limit and user's disk usage.hardLimit
- the returned value of the hard limit quota (in bytes) i.e. the real quota limit that cannot be exceeded.
AuthenticationFaultException
- a generic authentication problem occurred
GetQuotaManagementFaultException
- quota management is not active on the WM.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic void jobPurge(java.lang.String jobId) throws AuthorizationFaultException, AuthenticationFaultException, OperationNotAllowedFaultException, InvalidArgumentFaultException, JobUnknownFaultException, ServerOverloadedFaultException, ServiceException
jobId
- the identifier of the job
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
JobUnknownFaultException
- the given job has not been registered to the system
InvalidArgumentFaultException
- the given job Id is not valid
OperationNotAllowedFaultException
- the current job status does not allow requested operation.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic org.glite.wms.wmproxy.StringAndLongList getOutputFileList(java.lang.String jobId) throws AuthorizationFaultException, AuthenticationFaultException, OperationNotAllowedFaultException, InvalidArgumentFaultException, JobUnknownFaultException, ServerOverloadedFaultException, ServiceException
jobId
- the identifier of the job
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
JobUnknownFaultException
- the given job has not been registered to the system
InvalidArgumentFaultException
- the given job Id is not valid
OperationNotAllowedFaultException
- the current job status does not allow requested operation.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic org.glite.wms.wmproxy.StringAndLongList jobListMatch(java.lang.String jdl, java.lang.String delegationId) throws AuthorizationFaultException, AuthenticationFaultException, InvalidArgumentFaultException, NoSuitableResourcesFaultException, ServerOverloadedFaultException, ServiceException
jdl
- the job descriptiondelegationId
- the string used previously to delegate credential
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
NoSuitableResourcesFaultException
- no suitable resources matching job requirements have been found.
InvalidArgumentFaultException
- the given job JDL expression is not valid
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic void enableFilePerusal(java.lang.String jobId, org.glite.wms.wmproxy.StringList fileList) throws AuthorizationFaultException, AuthenticationFaultException, InvalidArgumentFaultException, JobUnknownFaultException, ServerOverloadedFaultException, ServiceException
fileList
- the list of filenames to be enabled
AuthorizationFaultException
- if the client is not authorized to perform this operation
AuthenticationFaultException
- a generic authentication problem occurred
InvalidArgumentFaultException
- the given jobId is not valid
OperationNotAllowedFaultException
- perusal was disabled with the specific jdl attribute.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operation
JobUnknownFaultException
getPerusalFiles(java.lang.String, java.lang.String, boolean)
,
getVersion()
public org.glite.wms.wmproxy.StringList getPerusalFiles(java.lang.String jobId, java.lang.String file, boolean allchunks) throws AuthorizationFaultException, AuthenticationFaultException, InvalidArgumentFaultException, JobUnknownFaultException, ServerOverloadedFaultException, ServiceException
file
- the name of the perusal file be enabled
AuthenticationFaultException
- An authentication problem occurred
AuthorizationFaultException
- The user is not authorized to perform this operation
InvalidArgumentFaultException
- If the given jobId is not valid
JobUnknownFaultException
- The provided jobId has not been registered to the system
OperationNotAllowedFaultexception
- perusal was disabled with the specific jdl attribute
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationenableFilePerusal(java.lang.String, org.glite.wms.wmproxy.StringList)
,
getVersion()
public java.lang.String getJobTemplate(org.glite.wms.wmproxy.JobTypeList jobType, java.lang.String executable, java.lang.String arguments, java.lang.String requirements, java.lang.String rank) throws AuthorizationFaultException, AuthenticationFaultException, InvalidArgumentFaultException, ServerOverloadedFaultException, ServiceException
jobType
- the job type descriptionexecutable
- the exacutable filenamearguments
- the arguments of the executablerequirements
- a string representing the expression describing all the Job requirements (which is an attribute of boolean type)rank
- a string representing the expression for the rank (which is an attribute of double type) of the resources
AuthenticationFaultException
- a generic authentication problem occurred.
AuthorizationFaultException
- if the client is not authorized to perform this operation.
InvalidArgumentFaultException
- one or more of the given input parameters is not valid
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic java.lang.String getDAGTemplate(org.glite.wms.wmproxy.GraphStructType dependencies, java.lang.String requirements, java.lang.String rank) throws AuthorizationFaultException, AuthenticationFaultException, InvalidArgumentFaultException, ServerOverloadedFaultException, ServiceException
dependencies
- the description of the DAGrequirements
- a string representing the expression describing all the Job requirements (which is an attribute of boolean type)rank
- a string representing the expression for the rank (which is an attribute of double type) for all the nodes of the dag
AuthenticationFaultException
- a generic authentication problem occurred.
AuthorizationFaultException
- if the client is not authorized to perform this operation.
InvalidArgumentFaultException
- one or more of the given input parameters is not valid
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic java.lang.String getCollectionTemplate(int jobNumber, java.lang.String requirements, java.lang.String rank) throws AuthorizationFaultException, AuthenticationFaultException, InvalidArgumentFaultException, ServerOverloadedFaultException, ServiceException
jobNumber
- integer representing the number of jobs of the collection.requirements
- a string representing the expression describing all the Job requirements (which is an attribute of boolean type)rank
- a string representing the expression for the rank (which is an attribute of double type) of the resources
AuthenticationFaultException
- a generic authentication problem occurred.
AuthorizationFaultException
- if the client is not authorized to perform this operation.
InvalidArgumentFaultException
- one or more of the given input parameters is not valid.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic java.lang.String getIntParametricJobTemplate(org.glite.wms.wmproxy.StringList attributes, int param, int parameterStart, int parameterStep, java.lang.String requirements, java.lang.String rank) throws AuthorizationFaultException, AuthenticationFaultException, InvalidArgumentFaultException, ServerOverloadedFaultException, ServiceException
attributes
- list of strings representing the parametric JDL attributesparam
- integer representing the value of the Parameter attributerequirements
- a string representing the expression describing all the Job requirements (which is an attribute of boolean type)rank
- a string representing the expression for the rank (which is an attribute of double type) of the resources
AuthenticationFaultException
- a generic authentication problem occurred.
AuthorizationFaultException
- if the client is not authorized to perform this operation.
InvalidArgumentFaultException
- one or more of the given input parameters is not valid.
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operationpublic java.lang.String getStringParametricJobTemplate(org.glite.wms.wmproxy.StringList attributes, org.glite.wms.wmproxy.StringList param, java.lang.String requirements, java.lang.String rank) throws AuthorizationFaultException, AuthenticationFaultException, InvalidArgumentFaultException, ServerOverloadedFaultException, ServiceException
attributes
- list of strings representing the parametric JDL attributesparam
- list of strings representing the values of the Parameter attributerequirements
- a string representing the expression describing all the Job requirements (which is an attribute of boolean type)rank
- a string representing the expression for the rank (which is an attribute of double type) of the resources
AuthenticationFaultException
- a generic authentication problem occurred.
AuthorizationFaultException
- if the client is not authorized to perform this operation.
InvalidArgumentFaultException
- one or more of the given input parameters is not valid
ServiceException
- If any other error occurs during the execution of the remote method call to the WMProxy server
ServerOverloadedFaultException
- the server is too much busy to attend the requested operation
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |