org.openhealthtools.ihe.atna.nodeauth

Interface SocketHandler

All Known Implementing Classes:

AbstractSecureSocketHandler, TLSEnabledSocketHandler

public interface SocketHandler

Interface for creating socket handlers in the Node Authentication Module. Specific actors / connectors needing access to an external resource via a socket may call methods in this interface, with the expectation of receiving an open socket ready for input/output and, if requested, secured using the mechanisms defined by the socket handler's implementation (e.g. mutually-authenticated TLSv1).

Author:

Glenn Deen, Matthew Davis

Method Summary

Modifier and Type	Method and Description
InputStream	getInputStream(URI uri) Negotiates and creates a socket for a given URI and returns the InputStream associated with the socket.
InputStream	getInputStream(URI uri, SecurityDomain securityDomain) Negotiates and creates a socket for a given URI and returns the InputStream associated with the socket.
Socket	getSocket(String host, int port, boolean useSecureSocket) Negotiates and creates a socket for a given hostname and port If requested, the socket is secured using the implementation's security mechanisms and the default SecurityDomain for this host and port
Socket	getSocket(String host, int port, boolean useSecureSocket, SecurityDomain securityDomain) Negotiates and creates a socket for a given hostname and port.
Socket	getSocket(String host, int port, boolean useSecureSocket, SecurityDomain securityDomain, Socket socketWrapper) Negotiates and creates a socket for a given hostname and port.
Socket	getSocket(URI uri, boolean useSecureSocket) Negotiates and creates a socket for a given URI.
Socket	getSocket(URI uri, boolean useSecureSocket, SecurityDomain securityDomain) Negotiates and creates a socket for a given URI.

Method Detail

getSocket

Socket getSocket(String host,
                 int port,
                 boolean useSecureSocket)
          throws Exception

Negotiates and creates a socket for a given hostname and port If requested, the socket is secured using the implementation's security mechanisms and the default SecurityDomain for this host and port

Parameters:

host - The hostname or IP address to create a socket to

port - The port to create a socket to

useSecureSocket - If the socket should be secured

Returns:

A socket ready for input/output

Throws:

Exception

getSocket

Socket getSocket(String host,
                 int port,
                 boolean useSecureSocket,
                 SecurityDomain securityDomain)
          throws Exception

Negotiates and creates a socket for a given hostname and port. If a secure socket is requested, the supplied "SecurityDomain" configuration is used for keystore, truststore, and cipher information.

Parameters:

host - The hostname or IP address to create a socket to

port - The port to create a socket to

useSecureSocket - If the socket should be secured

securityDomain - Security Domain config to use in securing the socket

Returns:

A socket ready for input/output

Throws:

Exception

getSocket

Socket getSocket(URI uri,
                 boolean useSecureSocket)
          throws Exception

Negotiates and creates a socket for a given URI. If requested, the socket is secured using the implementation's security mechanisms and the default SecurityDomain for this URI.

Parameters:

uri - The URI for which to open the socket

useSecureSocket - If the socket should be secured

Returns:

A socket ready for input/output

Throws:

Exception

getSocket

Socket getSocket(URI uri,
                 boolean useSecureSocket,
                 SecurityDomain securityDomain)
          throws Exception

Negotiates and creates a socket for a given URI. If a secure socket is requested, the supplied "SecurityDomain" configuration is used for keystore, truststore, and cipher information.

Parameters:

uri - The URI for which to open the socket

useSecureSocket - If the socket should be secured

securityDomain - Security Domain config to use in securing the socket

Returns:

A socket ready for input/output

Throws:

Exception

getSocket

Socket getSocket(String host,
                 int port,
                 boolean useSecureSocket,
                 SecurityDomain securityDomain,
                 Socket socketWrapper)
          throws Exception

Negotiates and creates a socket for a given hostname and port. If a secure socket is requested, the supplied "SecurityDomain" configuration is used for keystore, truststore, and cipher information.

Parameters:

host - The hostname or IP address to create a socket to

port - The port to create a socket to

useSecureSocket - If the socket should be secured

securityDomain - Security Domain config to use in securing the socket

socketWrapper - Socket to wrap connection in, generally for HTTPS tunnels

Returns:

A socket ready for input/output

Throws:

Exception

getInputStream

InputStream getInputStream(URI uri)
                    throws Exception

Negotiates and creates a socket for a given URI and returns the InputStream associated with the socket. If a "secure" URI is given (e.g. HTTPS), then a secure socket is created using the implementation's security mechanism.

Parameters:

uri - The URI for which to open the socket

Returns:

An InputStream for reading from the socket

Throws:

Exception

getInputStream

InputStream getInputStream(URI uri,
                           SecurityDomain securityDomain)
                    throws Exception

Negotiates and creates a socket for a given URI and returns the InputStream associated with the socket. If a "secure" URI is given (e.g. HTTPS), then a secure socket is given created by the implementation's security mechanism using the SecurityDomain configuration supplied.

Parameters:

uri - The URI for which to open the socket

securityDomain - Security Domain config to use in securing the socket

Returns:

An InputStream for reading from the socket

Throws:

Exception