se.esss.ics.rbac.access

Interface IConnectionFactory

All Superinterfaces:

Serializable

All Known Implementing Classes:

RBACConnectionFactory

public interface IConnectionFactory
extends Serializable

IConnectionFactory defines the factory that creates connections to the requested URLs.

Author:

Jaka Bobnar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IConnectionFactory.Service Service identifies the service that is being used by the connection factory.

Method Summary

Modifier and Type	Method and Description
HttpURLConnection	getConnection(SecurityCallback callback, String urlString, String requestMethod) Creates a new HTTP connection to the provided URL using the given request method.
HttpURLConnection	getConnection(SecurityCallback callback, String urlString, String requestMethod, Map<String,String> requestProperties) Creates a new HTTP connection to the provided URL.
IConnectionFactory.Service	getService() Returns the service that is being used for all connections.
IConnectionFactory.Service	switchService() Switch the currently used service from primary to secondary or vice versa.

Method Detail

getConnection

HttpURLConnection getConnection(SecurityCallback callback,
                                String urlString,
                                String requestMethod)
                         throws ConnectionException

Creates a new HTTP connection to the provided URL using the given request method. The URL is given as a relative path to the base server URL, which means that the provided URL should be appended to the currently used base URL. No HTTP request headers are set when creating the connection. This is equivalent to calling getConnection(SecurityCallback, String, String, Map) with null or empty map.

Parameters:

callback - the security callback which is notified if a certificate needs to be accepted

urlString - URL to connect to

requestMethod - HTTP request method (GET, POST, DELETE, etc.)

Returns:

HTTP connection to the provided URL

Throws:

ConnectionException - if there was an error creating the connection

See Also:

getConnection(SecurityCallback, String, String, Map)

getConnection

HttpURLConnection getConnection(SecurityCallback callback,
                                String urlString,
                                String requestMethod,
                                Map<String,String> requestProperties)
                         throws ConnectionException

Creates a new HTTP connection to the provided URL. URL is given as a relative path and should be appended to the server base URL. The connection is set to use the given HTTP request method (GET, POST, DELETE, etc.) and has additional request properties (headers) set, as defined in the requestProperties parameter. When a connection is created its verifier is set to only allow connections to the RBAC authentication server. It is expected that the connection to the URL is verified and that any certificate (that might be issued by the server) is trusted before the connection is returned. The provided callback can be used to accept or deny certificate.

Parameters:

callback - the security callback which is notified in case a certificate needs to be accepted

urlString - URL to connect to

requestMethod - HTTP request method (GET, POST, DELETE, etc.)

requestProperties - map of additional HTTP request properties (headers)

Returns:

HTTP connection to the provided URL

Throws:

ConnectionException - if there was an error creating the connection

See Also:

SecurityCallback.acceptCertificate(String, java.security.cert.X509Certificate)

switchService

IConnectionFactory.Service switchService()

Switch the currently used service from primary to secondary or vice versa. The method should always switch from one service to another.

Returns:

the service that is being used after this call

getService

IConnectionFactory.Service getService()

Returns the service that is being used for all connections.

Returns:

the currently used service