org.gcube.data.analysis.dataminermanagercl.server.dmservice

Class SClient4WPS

java.lang.Object

org.gcube.data.analysis.dataminermanagercl.server.dmservice.SClient

org.gcube.data.analysis.dataminermanagercl.server.dmservice.SClient4WPS

All Implemented Interfaces:

Serializable

public class SClient4WPS
extends SClient

Client 4 WPS Service

Author:

Giancarlo Panichi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SClient4WPS(ServiceCredentials serviceCredentials)
SClient4WPS(ServiceCredentials serviceCredentials, String serviceAddress)

Method Summary

Modifier and Type	Method and Description
String	cancelComputation(ComputationId computationId) Cancel a computation
ComputationData	getComputationDataByComputationProperties(Map<String,String> computationProperties) Get Computation Data by computation properties
ComputationStatus	getComputationStatus(ComputationId computationId) Get Computation Status
List<Parameter>	getInputParameters(Operator operator) Get input paramters of the operator
Operator	getOperatorById(String id) Retrieve the operator by id
Operator	getOperatorById(String id, boolean refresh)
List<OperatorsClassification>	getOperatorsClassifications() Retrieve the list of operators
List<OperatorsClassification>	getOperatorsClassifications(boolean refresh) Retrieve the list of operators and refresh them if required
OutputData	getOutputDataByComputationId(ComputationId computationId) Get Output of computation
List<Parameter>	getOutputParameters(Operator operator) Get output paramters of the operator
ServiceInfo	getServiceInfo() Retrieve service info
ComputationId	resubmitComputation(Map<String,String> computationProperties) Resubmit a computation only by computation properties
ComputationId	startComputation(Operator operator) Start Computation
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SClient4WPS

public SClient4WPS(ServiceCredentials serviceCredentials)
            throws ServiceException

Parameters:

serviceCredentials - sevice credentials

Throws:

ServiceException - ServiceException

SClient4WPS

public SClient4WPS(ServiceCredentials serviceCredentials,
                   String serviceAddress)
            throws ServiceException

Parameters:

serviceCredentials - sevice credentials

serviceAddress - valid url for example: http://dataminer1-devnext.d4science.org/wps/

Throws:

ServiceException - ServiceException

Method Detail

getServiceInfo

public ServiceInfo getServiceInfo()
                           throws ServiceException

Description copied from class: SClient

Retrieve service info

Specified by:

getServiceInfo in class SClient

Returns:

service info

Throws:

ServiceException

getOperatorById

public Operator getOperatorById(String id)
                         throws Exception

Description copied from class: SClient

Retrieve the operator by id

Specified by:

getOperatorById in class SClient

Parameters:

id - operator id

Returns:

operator

Throws:

Exception - exception

getOperatorById

public Operator getOperatorById(String id,
                                boolean refresh)
                         throws Exception

Specified by:

getOperatorById in class SClient

Parameters:

id - operator id

refresh - if true refresh the operators in cache

Returns:

operator

Throws:

Exception - exception

getOperatorsClassifications

public List<OperatorsClassification> getOperatorsClassifications()
                                                          throws ServiceException

Description copied from class: SClient

Retrieve the list of operators

Specified by:

getOperatorsClassifications in class SClient

Returns:

list of operators classification

Throws:

ServiceException

getOperatorsClassifications

public List<OperatorsClassification> getOperatorsClassifications(boolean refresh)
                                                          throws ServiceException

Description copied from class: SClient

Retrieve the list of operators and refresh them if required

Specified by:

getOperatorsClassifications in class SClient

Parameters:

refresh - refresh operators in cache

Returns:

list of operators classification

Throws:

ServiceException

getInputParameters

public List<Parameter> getInputParameters(Operator operator)
                                   throws ServiceException

Description copied from class: SClient

Get input paramters of the operator

Specified by:

getInputParameters in class SClient

Parameters:

operator - operator

Returns:

list of parameter

Throws:

ServiceException

getOutputParameters

public List<Parameter> getOutputParameters(Operator operator)
                                    throws Exception

Description copied from class: SClient

Get output paramters of the operator

Specified by:

getOutputParameters in class SClient

Parameters:

operator - operator

Returns:

list of parameter

Throws:

Exception - exception

startComputation

public ComputationId startComputation(Operator operator)
                               throws ServiceException

Description copied from class: SClient

Start Computation

Specified by:

startComputation in class SClient

Parameters:

operator - operator

Returns:

computation id

Throws:

ServiceException

getComputationStatus

public ComputationStatus getComputationStatus(ComputationId computationId)
                                       throws ServiceException

Description copied from class: SClient

Get Computation Status

Specified by:

getComputationStatus in class SClient

Parameters:

computationId - computation Id

Returns:

computation status

Throws:

ServiceException

getOutputDataByComputationId

public OutputData getOutputDataByComputationId(ComputationId computationId)
                                        throws ServiceException

Description copied from class: SClient

Get Output of computation

Specified by:

getOutputDataByComputationId in class SClient

Parameters:

computationId - computation id

Returns:

output data

Throws:

ServiceException

cancelComputation

public String cancelComputation(ComputationId computationId)
                         throws ServiceException

Description copied from class: SClient

Cancel a computation

Specified by:

cancelComputation in class SClient

Parameters:

computationId - computation Id

Returns:

cancel

Throws:

ServiceException

resubmitComputation

public ComputationId resubmitComputation(Map<String,String> computationProperties)
                                  throws ServiceException

Description copied from class: SClient

Resubmit a computation only by computation properties

Specified by:

resubmitComputation in class SClient

Parameters:

computationProperties - map of computation properties

Returns:

computation id

Throws:

ServiceException

getComputationDataByComputationProperties

public ComputationData getComputationDataByComputationProperties(Map<String,String> computationProperties)
                                                          throws ServiceException

Description copied from class: SClient

Get Computation Data by computation properties

Specified by:

getComputationDataByComputationProperties in class SClient

Parameters:

computationProperties - computation properties

Returns:

computation data

Throws:

ServiceException

toString

public String toString()

Overrides:

toString in class SClient