net.environmatics.acs.accessor.interfaces

Interface WSSAccessor

All Known Implementing Classes:

WSSAccessorDeegree

public interface WSSAccessor

Generic interface for WSS interaction.

Version:

$Revision$, $Date$

Author:

abonitz

Field Summary

Fields

Modifier and Type	Field and Description
static String	DCP_HTTP_GET DCP Method: GET
static String	DCP_HTTP_POST DCP Method: POST

Method Summary

Modifier and Type	Method and Description
void	closeSession() Closes the WSS session.
Payload	doService(String dcp_type, String serviceRequest, org.apache.commons.httpclient.NameValuePair[] requestParams, String facadeURL) Performs a doService request on the selected WSS.
Payload	doService(String dcp_type, String serviceRequest, String facadeURL) Performs a doService request on the selected WSS.
SessionInformation	getSession(AuthenticationMethod authnMethod) Establishes a session between the WSSAccessor and the remote WSS service.
List<String>	getSupportedAuthenticationMethods() Retrieves the capabilities document of a WSS, parses it and returns the supported auhtentication methods.
String	getWSS() Returns the URL to the used WSS.
org.dom4j.Document	getWSSCapabilities() Tries to retrieve the capabillities document from the specific WSS.
void	setAuthenticationMethod(AuthenticationMethod authnMethod) Sets the authentication method for WSS interaction.
void	setCredentialProvider(org.apache.commons.httpclient.auth.CredentialsProvider credentialProvider) DOCUMENT ME!
void	setProxy(String proxy_url, int port) Sets a proxy for indirect HTTP communication.
void	setWSS(String wssUrl) Sets the URL of WSS to use.

Field Detail

DCP_HTTP_GET

static final String DCP_HTTP_GET

DCP Method: GET

See Also:

Constant Field Values

DCP_HTTP_POST

static final String DCP_HTTP_POST

DCP Method: POST

See Also:

Constant Field Values

Method Detail

closeSession

void closeSession()
           throws ServiceException

Closes the WSS session.

Throws:

ServiceException - Is thrown, when closeSession() fails on the WSS

doService

Payload doService(String dcp_type,
                  String serviceRequest,
                  org.apache.commons.httpclient.NameValuePair[] requestParams,
                  String facadeURL)
           throws ServiceException

Performs a doService request on the selected WSS.

Parameters:

dcp_type - Must be HTTP GET or HTTP POST

serviceRequest - Request to a secured service

requestParams - An array with request parameters, i.e. HTTP_Header / Mime-Type: text/xml

facadeURL - String with an URL to facade

Returns:

Payload, containing the doService response.

Throws:

ServiceException - Thrown in case of an error.

doService

Payload doService(String dcp_type,
                  String serviceRequest,
                  String facadeURL)
           throws ServiceException

Performs a doService request on the selected WSS. Note that this method sets the WSS doService request parameters to "HTTP_Header" with "Mime-Type: text/xml"

Parameters:

dcp_type - Must be HTTP GET or HTTP POST

serviceRequest - Request to a secured service

facadeURL - String with an URL to facade

Returns:

Payload, containing the doService response.

Throws:

ServiceException - Thrown in case of an error.

getSession

SessionInformation getSession(AuthenticationMethod authnMethod)
                       throws AuthenticationFailedException

Establishes a session between the WSSAccessor and the remote WSS service.

Parameters:

authnMethod - The authentication method which should be used

Returns:

DOCUMENT ME!

Throws:

AuthenticationFailedException - Is thrown, when the authentication fails

getSupportedAuthenticationMethods

List<String> getSupportedAuthenticationMethods()

Retrieves the capabilities document of a WSS, parses it and returns the supported auhtentication methods. If the WSS does not respond, the method returns an empty List.

Returns:

a List with the IDs of all supported auhtentication methods

getWSS

String getWSS()

Returns the URL to the used WSS.

Returns:

URL as String

getWSSCapabilities

org.dom4j.Document getWSSCapabilities()

Tries to retrieve the capabillities document from the specific WSS.

Returns:

the capabillities document as Dom4J Document, or in case of an error null

setAuthenticationMethod

void setAuthenticationMethod(AuthenticationMethod authnMethod)

Sets the authentication method for WSS interaction.

Parameters:

authnMethod - The authentication method that shall be used.

setProxy

void setProxy(String proxy_url,
              int port)

Sets a proxy for indirect HTTP communication.

Parameters:

proxy_url - URL of the proxy to use.

port - The port of the proxy server.

setCredentialProvider

void setCredentialProvider(org.apache.commons.httpclient.auth.CredentialsProvider credentialProvider)

DOCUMENT ME!

Parameters:

credentialProvider - DOCUMENT ME!

setWSS

void setWSS(String wssUrl)

Sets the URL of WSS to use.

Parameters:

wssUrl - URL of an WSS