de.cismet.commons.security.handler

Class SimpleHttpAccessHandler

java.lang.Object

de.cismet.commons.security.handler.AbstractAccessHandler

de.cismet.commons.security.handler.SimpleHttpAccessHandler

All Implemented Interfaces:

AccessHandler, ExtendedAccessHandler, ProxyCabaple

public class SimpleHttpAccessHandler
extends AbstractAccessHandler
implements ExtendedAccessHandler, ProxyCabaple

The SimpleHTTPAccessHandler is a HTTPAccessHandler that uses no Credential Provider. It can therefore be used only for resources with no authentication

Version:

$Revision$, $Date$

Author:

spuhl, thorsten

Nested Class Summary

Nested classes/interfaces inherited from interface de.cismet.commons.security.AccessHandler

AccessHandler.ACCESS_HANDLER_TYPES, AccessHandler.ACCESS_METHODS

Field Summary

Fields

Modifier and Type	Field and Description
static AccessHandler.ACCESS_HANDLER_TYPES	ACCESS_HANDLER_TYPE
static AccessHandler.ACCESS_METHODS[]	SUPPORTED_ACCESS_METHODS

Constructor Summary

Constructors

Constructor and Description
SimpleHttpAccessHandler() Creates a new DefaultHTTPAccessHandler object.
SimpleHttpAccessHandler(int connectionTimeout, int soTimeout) Creates a new SimpleHttpAccessHandler object.
SimpleHttpAccessHandler(Proxy proxy) Creates a new SimpleHttpAccessHandler object.
SimpleHttpAccessHandler(Proxy proxy, int connectionTimeout, int soTimeout) Creates a new SimpleHttpAccessHandler object.

Method Summary

Modifier and Type	Method and Description
boolean	checkIfURLaccessible(URL url) DOCUMENT ME!
InputStream	doMultipartRequest(URL url, org.apache.commons.httpclient.methods.multipart.Part[] parts, HashMap<String,String> requestHeader) DOCUMENT ME!
InputStream	doRequest(URL url) DOCUMENT ME!
InputStream	doRequest(URL url, InputStream requestParameter, HashMap<String,String> requestHeader) Send binary data in a POST request.
InputStream	doRequest(URL url, Reader requestParameter, AccessHandler.ACCESS_METHODS method, HashMap<String,String> options) todo idee default dorequest ohne accessMethod jeder handler entscheided selbst wie der default fall aussieht.
InputStream	doRequest(URL url, Reader requestParameter, AccessHandler.ACCESS_METHODS method, HashMap<String,String> options, org.apache.commons.httpclient.UsernamePasswordCredentials credentials) DOCUMENT ME!
InputStream	doRequest(URL url, Reader requestParameter, String requestHeader, AccessHandler.ACCESS_METHODS method, HashMap<String,String> options, org.apache.commons.httpclient.UsernamePasswordCredentials credentials) DOCUMENT ME!
InputStream	doRequest(URL url, Reader requestParameter, String requestHeader, AccessHandler.ACCESS_METHODS method, HashMap<String,String> options, org.apache.commons.httpclient.UsernamePasswordCredentials credentials, boolean withHeaders) DOCUMENT ME!
protected org.apache.commons.httpclient.HttpClient	getConfiguredHttpClient(URL url) Returns a configured HttpClient with (if set) proxy settings.
AccessHandler.ACCESS_HANDLER_TYPES	getHandlerType() DOCUMENT ME!
protected org.apache.commons.httpclient.HttpClient	getSecurityEnabledHttpClient(URL url) DOCUMENT ME!
boolean	isAccessMethodSupported(AccessHandler.ACCESS_METHODS method) DOCUMENT ME!
void	setProxy(Proxy proxy) DOCUMENT ME!

Methods inherited from class de.cismet.commons.security.handler.AbstractAccessHandler

doRequest

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_ACCESS_METHODS

public static AccessHandler.ACCESS_METHODS[] SUPPORTED_ACCESS_METHODS

ACCESS_HANDLER_TYPE

public static final AccessHandler.ACCESS_HANDLER_TYPES ACCESS_HANDLER_TYPE

Constructor Detail

SimpleHttpAccessHandler

public SimpleHttpAccessHandler()

Creates a new DefaultHTTPAccessHandler object.

SimpleHttpAccessHandler

public SimpleHttpAccessHandler(Proxy proxy)

Creates a new SimpleHttpAccessHandler object.

Parameters:

proxy - DOCUMENT ME!

SimpleHttpAccessHandler

public SimpleHttpAccessHandler(int connectionTimeout,
                               int soTimeout)

Creates a new SimpleHttpAccessHandler object.

Parameters:

connectionTimeout - DOCUMENT ME!

soTimeout - DOCUMENT ME!

SimpleHttpAccessHandler

public SimpleHttpAccessHandler(Proxy proxy,
                               int connectionTimeout,
                               int soTimeout)

Creates a new SimpleHttpAccessHandler object.

Parameters:

proxy - DOCUMENT ME!

connectionTimeout - DOCUMENT ME!

soTimeout - DOCUMENT ME!

Method Detail

doRequest

public InputStream doRequest(URL url,
                             Reader requestParameter,
                             AccessHandler.ACCESS_METHODS method,
                             HashMap<String,String> options)
                      throws Exception

Description copied from interface: AccessHandler

todo idee default dorequest ohne accessMethod jeder handler entscheided selbst wie der default fall aussieht.

Specified by:

doRequest in interface AccessHandler

Parameters:

url - DOCUMENT ME!

requestParameter - DOCUMENT ME!

method - DOCUMENT ME!

options - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

doRequest

public InputStream doRequest(URL url,
                             Reader requestParameter,
                             AccessHandler.ACCESS_METHODS method,
                             HashMap<String,String> options,
                             org.apache.commons.httpclient.UsernamePasswordCredentials credentials)
                      throws Exception

DOCUMENT ME!

Parameters:

url - DOCUMENT ME!

requestParameter - DOCUMENT ME!

method - DOCUMENT ME!

options - DOCUMENT ME!

credentials - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

doRequest

public InputStream doRequest(URL url,
                             Reader requestParameter,
                             String requestHeader,
                             AccessHandler.ACCESS_METHODS method,
                             HashMap<String,String> options,
                             org.apache.commons.httpclient.UsernamePasswordCredentials credentials)
                      throws Exception

DOCUMENT ME!

Parameters:

url - DOCUMENT ME!

requestParameter - DOCUMENT ME!

requestHeader - DOCUMENT ME!

method - DOCUMENT ME!

options - DOCUMENT ME!

credentials - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

doRequest

public InputStream doRequest(URL url,
                             Reader requestParameter,
                             String requestHeader,
                             AccessHandler.ACCESS_METHODS method,
                             HashMap<String,String> options,
                             org.apache.commons.httpclient.UsernamePasswordCredentials credentials,
                             boolean withHeaders)
                      throws Exception

DOCUMENT ME!

Parameters:

url - DOCUMENT ME!

requestParameter - DOCUMENT ME!

requestHeader - DOCUMENT ME!

method - DOCUMENT ME!

options - DOCUMENT ME!

credentials - DOCUMENT ME!

withHeaders - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

doRequest

public InputStream doRequest(URL url,
                             InputStream requestParameter,
                             HashMap<String,String> requestHeader)
                      throws Exception

Description copied from interface: AccessHandler

Send binary data in a POST request.

Specified by:

doRequest in interface AccessHandler

Parameters:

url - The URL where the data is sent to.

requestParameter - The payload.

requestHeader - The headers to add to the POST request.

Returns:

The response.

Throws:

Exception - DOCUMENT ME!

doMultipartRequest

public InputStream doMultipartRequest(URL url,
                                      org.apache.commons.httpclient.methods.multipart.Part[] parts,
                                      HashMap<String,String> requestHeader)
                               throws Exception

DOCUMENT ME!

Parameters:

url - DOCUMENT ME!

parts - DOCUMENT ME!

requestHeader - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

setProxy

public void setProxy(Proxy proxy)

Description copied from interface: ProxyCabaple

DOCUMENT ME!

Specified by:

setProxy in interface ProxyCabaple

Parameters:

proxy - DOCUMENT ME!

isAccessMethodSupported

public boolean isAccessMethodSupported(AccessHandler.ACCESS_METHODS method)

Description copied from interface: AccessHandler

DOCUMENT ME!

Specified by:

isAccessMethodSupported in interface AccessHandler

Parameters:

method - DOCUMENT ME!

Returns:

DOCUMENT ME!

getHandlerType

public AccessHandler.ACCESS_HANDLER_TYPES getHandlerType()

Description copied from interface: AccessHandler

DOCUMENT ME!

Specified by:

getHandlerType in interface AccessHandler

Returns:

DOCUMENT ME!

getSecurityEnabledHttpClient

protected org.apache.commons.httpclient.HttpClient getSecurityEnabledHttpClient(URL url)

DOCUMENT ME!

Parameters:

url - DOCUMENT ME!

Returns:

DOCUMENT ME!

getConfiguredHttpClient

protected org.apache.commons.httpclient.HttpClient getConfiguredHttpClient(URL url)

Returns a configured HttpClient with (if set) proxy settings.

Parameters:

url - DOCUMENT ME!

Returns:

configured HttpClient

doRequest

public InputStream doRequest(URL url)
                      throws Exception

Description copied from interface: ExtendedAccessHandler

DOCUMENT ME!

Specified by:

doRequest in interface ExtendedAccessHandler

Parameters:

url - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

checkIfURLaccessible

public boolean checkIfURLaccessible(URL url)

Description copied from interface: ExtendedAccessHandler

DOCUMENT ME!

Specified by:

checkIfURLaccessible in interface ExtendedAccessHandler

Parameters:

url - DOCUMENT ME!

Returns:

DOCUMENT ME!