net.environmatics.acs.accessor

Class WSSAccessorDeegree

java.lang.Object

net.environmatics.acs.accessor.WSSAccessorDeegree

All Implemented Interfaces:

WSSAccessor

public class WSSAccessorDeegree
extends Object
implements WSSAccessor

Main Class for Interaction with an deegree WebSecurityService.

Note: Uses the anonymous authentication as default

Example:
// Creating new accessor instance WSSAccessorDeegree accessor = new WSSAccessorDeegree("http://myservices.com/wss");

// Choosing a authentication method
PasswordAuthenticationMethod authMethod = new PasswordAuthenticationMethod("user","pass");

// Use the auth. method with the accessor
accessor.setAuthenticationMethod(authMethod);

// Perform a doService Operation on the WSS, in this case with a GetCapabilities
// operation on a secured WMS
Payload response = accessor.doService("HTTP_GET", "SERVICE=WMS&REQUEST=GetCapabilities", "http://localhost:8080/facadeURL");


Version:

$Revision$, $Date$

Author:

abonitz

Field Summary

Fields inherited from interface net.environmatics.acs.accessor.interfaces.WSSAccessor

DCP_HTTP_GET, DCP_HTTP_POST

Constructor Summary

Constructors

Constructor and Description
WSSAccessorDeegree() Creates a new instance of the WSSAccessorDeegree.
WSSAccessorDeegree(String wssURL) Creates a new instance of the WSSAccessorDeegree.
WSSAccessorDeegree(String wssURL, String proxyURL, int port) Creates a new instance of the WSSAccessorDeegree.

Method Summary

Modifier and Type	Method and Description
void	closeSession() Closes the WSS session.
void	closeSession(SessionInformation si) 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.
String	getSecuredServiceType() DOCUMENT ME!
SessionInformation	getSession() Establishes a session between the WSSAccessor and the remote WSS service.
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.
URL	getWSSURL() DOCUMENT ME!
boolean	isSessionAvailable() DOCUMENT ME!
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

WSSAccessorDeegree

public WSSAccessorDeegree()

Creates a new instance of the WSSAccessorDeegree.

WSSAccessorDeegree

public WSSAccessorDeegree(String wssURL)

Creates a new instance of the WSSAccessorDeegree.

Parameters:

wssURL - URL to a WSS

WSSAccessorDeegree

public WSSAccessorDeegree(String wssURL,
                          String proxyURL,
                          int port)

Creates a new instance of the WSSAccessorDeegree.

Parameters:

wssURL - URL to a WSS

proxyURL - URL to a proxy server

port - The port of the proxy server

Method Detail

doService

public 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.

Specified by:

doService in interface WSSAccessor

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.

NullPointerException - DOCUMENT ME!

doService

public 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"

Specified by:

doService in interface WSSAccessor

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

public SessionInformation getSession(AuthenticationMethod authnMethod)
                              throws AuthenticationFailedException

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

Specified by:

getSession in interface WSSAccessor

Parameters:

authnMethod - The authentication method which should be used

Returns:

DOCUMENT ME!

Throws:

AuthenticationFailedException - Is thrown, when the authentication fails

NullPointerException - DOCUMENT ME!

getSession

public SessionInformation getSession()
                              throws AuthenticationFailedException

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

Returns:

DOCUMENT ME!

Throws:

AuthenticationFailedException - Is thrown, when the authentication fails

NullPointerException - DOCUMENT ME!

closeSession

public void closeSession()
                  throws ServiceException

Closes the WSS session.

Specified by:

closeSession in interface WSSAccessor

Throws:

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

NullPointerException - DOCUMENT ME!

closeSession

public void closeSession(SessionInformation si)
                  throws ServiceException

Closes the WSS session.

Parameters:

si - DOCUMENT ME!

Throws:

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

NullPointerException - DOCUMENT ME!

getWSS

public String getWSS()

Returns the URL to the used WSS.

Specified by:

getWSS in interface WSSAccessor

Returns:

URL as String

getWSSURL

public URL getWSSURL()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setProxy

public void setProxy(String proxy_url,
                     int port)

Sets a proxy for indirect HTTP communication.

Specified by:

setProxy in interface WSSAccessor

Parameters:

proxy_url - URL of the proxy to use.

port - The port of the proxy server.

setCredentialProvider

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

Description copied from interface: WSSAccessor

DOCUMENT ME!

Specified by:

setCredentialProvider in interface WSSAccessor

Parameters:

credentialProvider - DOCUMENT ME!

setWSS

public void setWSS(String wssUrl)

Sets the URL of WSS to use.

Specified by:

setWSS in interface WSSAccessor

Parameters:

wssUrl - URL of an WSS

setAuthenticationMethod

public void setAuthenticationMethod(AuthenticationMethod authnMethod)

Sets the authentication method for WSS interaction.

Specified by:

setAuthenticationMethod in interface WSSAccessor

Parameters:

authnMethod - The authentication method that shall be used.

getSupportedAuthenticationMethods

public 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.

Specified by:

getSupportedAuthenticationMethods in interface WSSAccessor

Returns:

a List with the IDs of all supported auhtentication methods

Throws:

NullPointerException - DOCUMENT ME!

getWSSCapabilities

public org.dom4j.Document getWSSCapabilities()

Tries to retrieve the capabillities document from the specific WSS.

Specified by:

getWSSCapabilities in interface WSSAccessor

Returns:

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

Throws:

NullPointerException - DOCUMENT ME!

getSecuredServiceType

public String getSecuredServiceType()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isSessionAvailable

public boolean isSessionAvailable()

DOCUMENT ME!

Returns:

DOCUMENT ME!