org.openhealthtools.ihe.atna.nodeauth.handlers

Class AbstractSecureSocketHandler

java.lang.Object

org.openhealthtools.ihe.atna.nodeauth.handlers.AbstractSecureSocketHandler

All Implemented Interfaces:

SocketHandler

Direct Known Subclasses:

TLSEnabledSocketHandler

public abstract class AbstractSecureSocketHandler
extends Object
implements SocketHandler

Abstract handler for all implementations of the secure socket handler

Author:

Glenn Deen, Rick Stevens, Sondra Renly, Matthew Davis

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeAuthModuleContext	CONTEXT Module context to use

Constructor Summary

Constructors

Constructor and Description
AbstractSecureSocketHandler(NodeAuthModuleContext context)

Method Summary

Modifier and Type	Method and Description
protected abstract Socket	createSecureSocket(String host, int port, SecurityDomain securityDomain, Socket socketWrapper) Creates a TLS-enabled secure socket for a given URI and SecurityDomain configuration
protected Socket	createSocket(String host, int port) Create non-secure socket for a given URI.
protected Socket	createSocketFromFactory(SocketFactory factory, String host, int port) Creates a new connected socket to a given host and port from a provided Socket Factory.
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 wantTLS) Negotiates and creates a socket for a given URI.
Socket	getSocket(URI uri, boolean wantTLS, SecurityDomain securityDomain) Negotiates and creates a socket for a given URI.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openhealthtools.ihe.atna.nodeauth.SocketHandler

getInputStream, getInputStream

Field Detail

CONTEXT

protected final NodeAuthModuleContext CONTEXT

Module context to use

Constructor Detail

AbstractSecureSocketHandler

public AbstractSecureSocketHandler(NodeAuthModuleContext context)

Method Detail

createSecureSocket

protected abstract Socket createSecureSocket(String host,
                                             int port,
                                             SecurityDomain securityDomain,
                                             Socket socketWrapper)
                                      throws Exception

Creates a TLS-enabled secure socket for a given URI and SecurityDomain configuration

Parameters:

host - Host to connect to

port - Port to connect to

securityDomain - Configuration options to use when securing the socket

Returns:

A socket secured using TLS for a given URI and SecurityDomain

Throws:

Exception

getSocket

public Socket getSocket(URI uri,
                        boolean wantTLS)
                 throws Exception

Description copied from interface: SocketHandler

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.

Specified by:

getSocket in interface SocketHandler

Parameters:

uri - The URI for which to open the socket

wantTLS - If the socket should be secured

Returns:

A socket ready for input/output

Throws:

Exception

getSocket

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

Description copied from interface: SocketHandler

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.

Specified by:

getSocket in interface SocketHandler

Parameters:

uri - The URI for which to open the socket

wantTLS - 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

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

Description copied from interface: SocketHandler

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

Specified by:

getSocket in interface SocketHandler

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

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

Description copied from interface: SocketHandler

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.

Specified by:

getSocket in interface SocketHandler

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

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

Description copied from interface: SocketHandler

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.

Specified by:

getSocket in interface SocketHandler

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

createSocket

protected Socket createSocket(String host,
                              int port)
                       throws SocketException,
                              UnknownHostException

Create non-secure socket for a given URI.

Parameters:

URI - uri to connect to

Returns:

socket

Throws:

SocketException

UnknownHostException

Exception

createSocketFromFactory

protected Socket createSocketFromFactory(SocketFactory factory,
                                         String host,
                                         int port)
                                  throws IOException

Creates a new connected socket to a given host and port from a provided Socket Factory.

Parameters:

factory - Java Socket Factory to use in the connection

host - Hostname to connect to

port - Port to connect to

Returns:

Connected socket instance from the given factory

Throws:

IOException