org.genepattern.webservice
Class AnalysisWebServiceProxy
java.lang.Object
 org.genepattern.webservice.AnalysisWebServiceProxy
- public class AnalysisWebServiceProxy
- extends java.lang.Object
|
Method Summary |
JobInfo |
checkStatus(int jobID)
Checks the status of a job. |
java.lang.String |
createProvenancePipeline(JobInfo[] jobs,
java.lang.String pipelineName)
|
java.lang.String |
createProvenancePipeline(java.lang.String fileUrlOrJobNumber,
java.lang.String pipelineName)
|
void |
deleteJob(int jobId)
|
void |
deleteJobResultFile(int jobId,
java.lang.String fileName)
|
JobInfo[] |
findJobsThatCreatedFile(java.lang.String fileURLOrJobNumber)
|
int[] |
getChildren(int jobNumber)
|
JobInfo[] |
getJobs(java.lang.String username,
boolean getAll)
|
java.lang.String[] |
getResultFiles(int jobID)
Returns the filenames that were generated by a completed job. |
TaskInfo[] |
getTasks()
Returns all the available tasks that can be used. |
java.lang.String |
ping()
Pings the service to see if it's alive. |
void |
purgeJob(int jobId)
|
JobInfo |
recordClientJob(int taskID,
ParameterInfo[] params)
|
JobInfo |
recordClientJob(int taskID,
ParameterInfo[] params,
int parentJobNumber)
|
void |
setJobStatus(int parentJobId,
java.lang.String status)
|
void |
setTimeout(int timeout)
|
JobInfo |
submitJob(int taskID,
ParameterInfo[] parameters)
Submits a job to be processed. |
JobInfo |
submitJob(int taskID,
ParameterInfo[] parameters,
int parentJobNumber)
Submits a job to be processed. |
void |
terminateJob(int jobId)
|
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
AnalysisWebServiceProxy
public AnalysisWebServiceProxy(java.lang.String url,
java.lang.String userName)
throws WebServiceException
AnalysisWebServiceProxy
public AnalysisWebServiceProxy(java.lang.String url,
java.lang.String userName,
boolean maintainSession)
throws WebServiceException
setTimeout
public void setTimeout(int timeout)
recordClientJob
public JobInfo recordClientJob(int taskID,
ParameterInfo[] params)
throws WebServiceException
- Throws:
WebServiceException
recordClientJob
public JobInfo recordClientJob(int taskID,
ParameterInfo[] params,
int parentJobNumber)
throws WebServiceException
- Throws:
WebServiceException
submitJob
public JobInfo submitJob(int taskID,
ParameterInfo[] parameters,
int parentJobNumber)
throws WebServiceException
- Submits a job to be processed. The job is a child job of the supplied parent job.
- Parameters:
taskID - Description of the Parameterparameters - Description of the Parameter
- Returns:
- Description of the Return Value
- Throws:
WebServiceException - Description of the Exception
submitJob
public JobInfo submitJob(int taskID,
ParameterInfo[] parameters)
throws WebServiceException
- Submits a job to be processed.
- Parameters:
taskID - Description of the Parameterparameters - Description of the Parameter
- Returns:
- Description of the Return Value
- Throws:
WebServiceException - Description of the Exception
checkStatus
public JobInfo checkStatus(int jobID)
throws WebServiceException
- Checks the status of a job.
- Parameters:
jobID - Description of the Parameter
- Returns:
- Description of the Return Value
- Throws:
WebServiceException - Description of the Exception
deleteJobResultFile
public void deleteJobResultFile(int jobId,
java.lang.String fileName)
throws WebServiceException
- Throws:
WebServiceException
deleteJob
public void deleteJob(int jobId)
throws WebServiceException
- Throws:
WebServiceException
purgeJob
public void purgeJob(int jobId)
throws WebServiceException
- Throws:
WebServiceException
ping
public java.lang.String ping()
throws WebServiceException
- Pings the service to see if it's alive.
- Returns:
- Description of the Return Value
- Throws:
WebServiceException - Description of the Exception
getTasks
public TaskInfo[] getTasks()
throws WebServiceException
- Returns all the available tasks that can be used.
- Returns:
- The tasks value
- Throws:
WebServiceException - Description of the Exception
getResultFiles
public java.lang.String[] getResultFiles(int jobID)
throws WebServiceException
- Returns the filenames that were generated by a completed job.
- Parameters:
jobID - Description of the Parameter
- Returns:
- The resultFiles value
- Throws:
WebServiceException - Description of the Exception
terminateJob
public void terminateJob(int jobId)
throws WebServiceException
- Throws:
WebServiceException
getJobs
public JobInfo[] getJobs(java.lang.String username,
boolean getAll)
throws WebServiceException
- Throws:
WebServiceException
setJobStatus
public void setJobStatus(int parentJobId,
java.lang.String status)
throws WebServiceException
- Throws:
WebServiceException
getChildren
public int[] getChildren(int jobNumber)
throws WebServiceException
- Throws:
WebServiceException
createProvenancePipeline
public java.lang.String createProvenancePipeline(JobInfo[] jobs,
java.lang.String pipelineName)
throws WebServiceException
- Throws:
WebServiceException
createProvenancePipeline
public java.lang.String createProvenancePipeline(java.lang.String fileUrlOrJobNumber,
java.lang.String pipelineName)
throws WebServiceException
- Throws:
WebServiceException
findJobsThatCreatedFile
public JobInfo[] findJobsThatCreatedFile(java.lang.String fileURLOrJobNumber)
throws WebServiceException
- Throws:
WebServiceException
|