org.gcube.portlets.user.dataminermanager.server.dmservice.wps

Class SClient4WPSSession

java.lang.Object

org.gcube.portlets.user.dataminermanager.server.dmservice.wps.SClient4WPSSession

All Implemented Interfaces:

Serializable

public class SClient4WPSSession
extends Object
implements Serializable

Author:

Giancarlo Panichi

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
HashMap<String,net.opengis.wps.x100.ProcessDescriptionsDocument>	processDescriptions

Constructor Summary

Constructors

Constructor and Description
SClient4WPSSession(String user, String password) Initializes a WPS client session.

Method Summary

Modifier and Type	Method and Description
String	cancelComputation(String url, String computationId)
boolean	connect(String url) Connects to a WPS and retrieves Capabilities plus puts all available Descriptions into cache.
boolean	connectForMonitoring(String url) Connects to a WPS and retrieves Capabilities plus puts all available Descriptions into cache.
net.opengis.wps.x100.ProcessDescriptionsDocument	describeAllProcesses(String url) retrieves all current available ProcessDescriptions of a WPS.
net.opengis.wps.x100.ProcessDescriptionsDocument	describeProcess(String[] processIDs, String serverID) retrieves the desired description for a service.
boolean	descriptionsAvailableInCache(String serverID) informs you if the descriptions for the specified service is already in the session.
void	disconnect(String url) removes a service from the session
Object	execute(String serverId, net.opengis.wps.x100.ExecuteDocument execute) Executes a process at a WPS
Object	executeViaGET(String urlString, String executeAsGETString) Executes a process at a WPS
net.opengis.wps.x100.ProcessDescriptionType[]	getAllProcessDescriptions(String wpsUrl) Delivers all ProcessDescriptions from a WPS
List<String>	getLoggedServices() returns the serverIDs of all loggedServices
net.opengis.wps.x100.ProcessDescriptionType	getProcessDescription(String serverID, String processID) return the processDescription for a specific process from Cache.
String[]	getProcessNames(String url)
net.opengis.wps.x100.CapabilitiesDocument	getWPSCaps(String url) provides you the cached capabilities for a specified service.
protected List<String>	retrievesSingleDescription(InputStream is)
boolean	serviceAlreadyRegistered(String serverID) looks up, if the service exists already in session.

Methods inherited from class java.lang.Object

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

Field Detail

processDescriptions

public HashMap<String,net.opengis.wps.x100.ProcessDescriptionsDocument> processDescriptions

Constructor Detail

SClient4WPSSession

public SClient4WPSSession(String user,
                          String password)

Initializes a WPS client session.

Parameters:

user - user

password - password

Method Detail

connect

public boolean connect(String url)
                throws org.n52.wps.client.WPSClientException

Connects to a WPS and retrieves Capabilities plus puts all available Descriptions into cache.

Parameters:

url - the entry point for the service. This is used as id for further identification of the service.

Returns:

true, if connect succeeded, false else.

Throws:

org.n52.wps.client.WPSClientException - wps client exception

connectForMonitoring

public boolean connectForMonitoring(String url)
                             throws org.n52.wps.client.WPSClientException

Connects to a WPS and retrieves Capabilities plus puts all available Descriptions into cache.

Parameters:

url - the entry point for the service. This is used as id for further identification of the service.

Returns:

true, if connect succeeded, false else.

Throws:

org.n52.wps.client.WPSClientException - wps client exception

disconnect

public void disconnect(String url)

removes a service from the session

Parameters:

url - url

getLoggedServices

public List<String> getLoggedServices()

returns the serverIDs of all loggedServices

Returns:

list of service

descriptionsAvailableInCache

public boolean descriptionsAvailableInCache(String serverID)

informs you if the descriptions for the specified service is already in the session. in normal case it should return true :)

Parameters:

serverID - server id

Returns:

success if contain descriptions in cache

getProcessDescription

public net.opengis.wps.x100.ProcessDescriptionType getProcessDescription(String serverID,
                                                                         String processID)
                                                                  throws IOException

return the processDescription for a specific process from Cache.

Parameters:

serverID - server id

processID - process id

Returns:

a ProcessDescription for a specific process from Cache.

Throws:

IOException - IO exception

getAllProcessDescriptions

public net.opengis.wps.x100.ProcessDescriptionType[] getAllProcessDescriptions(String wpsUrl)
                                                                        throws IOException

Delivers all ProcessDescriptions from a WPS

Parameters:

wpsUrl - the URL of the WPS

Returns:

An Array of ProcessDescriptions

Throws:

IOException - IO exception

serviceAlreadyRegistered

public boolean serviceAlreadyRegistered(String serverID)

looks up, if the service exists already in session.

Parameters:

serverID - service id

Returns:

true if service is registered

getWPSCaps

public net.opengis.wps.x100.CapabilitiesDocument getWPSCaps(String url)

provides you the cached capabilities for a specified service.

Parameters:

url - service url

Returns:

capabilities document

describeAllProcesses

public net.opengis.wps.x100.ProcessDescriptionsDocument describeAllProcesses(String url)
                                                                      throws org.n52.wps.client.WPSClientException

retrieves all current available ProcessDescriptions of a WPS. Mention: to get the current list of all processes, which will be requested, the cached capabilities will be used. Please keep that in mind. the retrieved descriptions will not be cached, so only transient information!

Parameters:

url - service url

Returns:

process descriptions document

Throws:

org.n52.wps.client.WPSClientException - WPS Client expcetion

describeProcess

public net.opengis.wps.x100.ProcessDescriptionsDocument describeProcess(String[] processIDs,
                                                                        String serverID)
                                                                 throws org.n52.wps.client.WPSClientException

retrieves the desired description for a service. the retrieved information will not be held in cache!

Parameters:

processIDs - process ids

serverID - server id

Returns:

process description document

Throws:

org.n52.wps.client.WPSClientException - WPS Client expcetion

execute

public Object execute(String serverId,
                      net.opengis.wps.x100.ExecuteDocument execute)
               throws org.n52.wps.client.WPSClientException

Executes a process at a WPS

Parameters:

serverId - server id url of server not the entry additionally defined in the caps.

execute - Execute document

Returns:

either an ExecuteResponseDocument or an InputStream if asked for RawData or an Exception Report

Throws:

org.n52.wps.client.WPSClientException - WPS Client Exception

retrievesSingleDescription

protected List<String> retrievesSingleDescription(InputStream is)
                                           throws org.n52.wps.client.WPSClientException

Throws:

org.n52.wps.client.WPSClientException

getProcessNames

public String[] getProcessNames(String url)
                         throws IOException

Throws:

IOException

executeViaGET

public Object executeViaGET(String urlString,
                            String executeAsGETString)
                     throws org.n52.wps.client.WPSClientException

Executes a process at a WPS

Parameters:

urlString - url of server not the entry additionally defined in the caps.

executeAsGETString - KVP Execute request

Returns:

either an ExecuteResponseDocument or an InputStream if asked for RawData or an Exception Report

Throws:

org.n52.wps.client.WPSClientException - WPS Client exception

cancelComputation

public String cancelComputation(String url,
                                String computationId)
                         throws org.n52.wps.client.WPSClientException

Throws:

org.n52.wps.client.WPSClientException