org.n52.geoprocessing.wps.client

Class WPSClientSession

java.lang.Object

org.n52.geoprocessing.wps.client.WPSClientSession

public class WPSClientSession
extends Object

Contains some convenient methods to access and manage Web Processing Services in a very generic way. This is implemented as a singleton.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE
static String	VERSION_100
static String	VERSION_200

Constructor Summary

Constructors

Constructor and Description
WPSClientSession() Initializes a WPS client session.

Method Summary

Modifier and Type	Method and Description
void	cancelAsyncExecute()
int	checkService(String url, String payload)
boolean	connect(String url, String version) Connects to a WPS and retrieves Capabilities plus puts all available Descriptions into cache.
List<Process>	describeProcess(String[] processIDs, String serverID, String version) 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 url, Execute execute, String version) Executes a process at a WPS
Object	executeAsyncGetResponseImmediately(String url, Execute execute, String version) Executes a process at a WPS
List<Process>	getAllProcessDescriptions(String wpsUrl) Delivers all ProcessDescriptions from a WPS
String	getBearerToken()
static WPSClientSession	getInstance()
List<String>	getLoggedServices() returns the serverIDs of all loggedServices
Process	getProcessDescription(String serverID, String processID, String version) return the processDescription for a specific process from Cache.
String[]	getProcessNames(String url)
Object	getResultFromStatusLocation(String statusLocation) Get the result from a status location URL
WPSCapabilities	getWPSCaps(String url) provides you the cached capabilities for a specified service.
boolean	isUseBearerToken()
static void	reset() This resets the WPSClientSession.
Result	retrieveProcessResult(String url, String jobId)
boolean	serviceAlreadyRegistered(String serverID) looks up, if the service exists already in session.
void	setBearerToken(String bearerToken)
void	setUseBearerToken(boolean useBearerToken)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_100

public static final String VERSION_100

See Also:

Constant Field Values

VERSION_200

public static final String VERSION_200

See Also:

Constant Field Values

SERVICE

public static final String SERVICE

See Also:

Constant Field Values

Constructor Detail

WPSClientSession

public WPSClientSession()

Initializes a WPS client session.

Method Detail

getInstance

public static WPSClientSession getInstance()

reset

public static void reset()

This resets the WPSClientSession. This might be necessary, to get rid of old service entries/descriptions. However, the session has to be repopulated afterwards.

connect

public boolean connect(String url,
                       String version)
                throws 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.

version - the version of the WPS

Returns:

true, if connect succeeded, false else.

Throws:

WPSClientException - if the capabilities could not be requested

disconnect

public void disconnect(String url)

removes a service from the session

Parameters:

url - WPS URL

getLoggedServices

public List<String> getLoggedServices()

returns the serverIDs of all loggedServices

Returns:

List of logged service URLs

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 - WPS URL

Returns:

success true if the the process descriptions of the WPS are cached

getProcessDescription

public Process getProcessDescription(String serverID,
                                     String processID,
                                     String version)

return the processDescription for a specific process from Cache.

Parameters:

serverID - WPS URL

processID - id of the process

version - the version of the WPS

Returns:

a ProcessDescription for a specific process from Cache.

getAllProcessDescriptions

public List<Process> getAllProcessDescriptions(String wpsUrl)

Delivers all ProcessDescriptions from a WPS

Parameters:

wpsUrl - the URL of the WPS

Returns:

An Array of ProcessDescriptions

serviceAlreadyRegistered

public boolean serviceAlreadyRegistered(String serverID)

looks up, if the service exists already in session.

Parameters:

serverID - the URL of the WPS

Returns:

true if the service exists in this session

getWPSCaps

public WPSCapabilities getWPSCaps(String url)

provides you the cached capabilities for a specified service.

Parameters:

url - WPS URL

Returns:

WPSCapabilities object

describeProcess

public List<Process> describeProcess(String[] processIDs,
                                     String serverID,
                                     String version)
                              throws WPSClientException

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

Parameters:

processIDs - one or more process IDs

serverID - WPS URL

version - WPS version

Returns:

list of process objects

Throws:

WPSClientException - of the process description could not be requested

executeAsyncGetResponseImmediately

public Object executeAsyncGetResponseImmediately(String url,
                                                 Execute execute,
                                                 String version)
                                          throws WPSClientException,
                                                 IOException

Executes a process at a WPS

Parameters:

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

execute - Execute document

version - the version of the WPS

Returns:

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

Throws:

WPSClientException - if the initial execute request failed

IOException - if subsequent requests failed in async mode

execute

public Object execute(String url,
                      Execute execute,
                      String version)
               throws WPSClientException,
                      IOException

Executes a process at a WPS

Parameters:

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

execute - Execute document

version - the version of the WPS

Returns:

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

Throws:

WPSClientException - if the initial execute request failed

IOException - if subsequent requests failed in async mode

getProcessNames

public String[] getProcessNames(String url)
                         throws IOException

Throws:

IOException

cancelAsyncExecute

public void cancelAsyncExecute()

checkService

public int checkService(String url,
                        String payload)

getBearerToken

public String getBearerToken()

setBearerToken

public void setBearerToken(String bearerToken)

isUseBearerToken

public boolean isUseBearerToken()

setUseBearerToken

public void setUseBearerToken(boolean useBearerToken)

retrieveProcessResult

public Result retrieveProcessResult(String url,
                                    String jobId)
                             throws IOException,
                                    WPSClientException

Throws:

IOException

WPSClientException

getResultFromStatusLocation

public Object getResultFromStatusLocation(String statusLocation)
                                   throws MalformedURLException,
                                          WPSClientException,
                                          IOException

Get the result from a status location URL

Parameters:

statusLocation - The status location URL

Returns:

the result object

Throws:

MalformedURLException - if the status location URL is malformed

WPSClientException - if an exception concerning WPS communication occurred

IOException - if en exception during the general HTTPVcommunication occurred