org.openhealthtools.ihe.atna.nodeauth.context

Class NodeAuthModuleContext

java.lang.Object

org.openhealthtools.ihe.atna.context.AbstractModuleContext

org.openhealthtools.ihe.atna.nodeauth.context.NodeAuthModuleContext

All Implemented Interfaces:

Serializable, Cloneable

public class NodeAuthModuleContext
extends AbstractModuleContext

Module context that manages fixed resources and configuration options for the IHE Node Authentication (NA of ATNA) module. The primary purpose of this module is to enable the creation of sockets secured using Transport Layer Security (TLS) version 1, also known as the IHE ITI-19 Node Authentication transaction. These secured sockets may be non-encrypted (for trusted networks) or encrypted (for non-trusted networks) using a given set of ciphers. The most important part is the mutual authentication during socket negotiations, which ensure that a client and its peer are aware and trust each other using a private key and a set trusted certificates. The Node Authentication Context manages the following resources in a global scope:

• The Socket Handler (default is a TLS-enabled Socket Handler)
• The Security Domain manager and a mapping of URIs to security domain (default is to use Java System Property-assigned stores for all URIs)

Additionally, the context manages the following configuration settings, also in a global scope:

• Whether TLS security is enabled
• Whether non-TLS connections are allowed
• The number of times to retry a socket connection
• The wait time between socket retries
• The socket timeout wait time

Author:

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openhealthtools.ihe.atna.context.AbstractModuleContext

config, securityContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeAuthModuleContext() Default constructor using a blank (default-initialized) configuration

Method Summary

Modifier and Type	Method and Description
NodeAuthModuleConfig	getConfig()
static NodeAuthModuleContext	getContext() Returns the current singleton instance of the Node Authentication Module Context from the ThreadLocal cache.
String	getContextId()
SecurityDomainManager	getSecurityDomainManager() Gets the security domain manager that stores and associates domain configurations to fixed URLs.
SocketHandler	getSocketHandler() Gets the socket creation handler set in this context for creating secure and non-secured sockets
boolean	isNonTLSConnectionsPermitted() Returns if non-TLS connections can be created.
boolean	isTLSEnabled() Returns if TLS connections are currently allowed
void	setNonTLSConnectionsPermitted(boolean enableNonTLS) Sets if non-TLS connections are permitted
void	setTLSEnabled(boolean enableTLS) Sets if TLS connections are currently allowed

Methods inherited from class org.openhealthtools.ihe.atna.context.AbstractModuleContext

getSecurityContext

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeAuthModuleContext

protected NodeAuthModuleContext()

Default constructor using a blank (default-initialized) configuration

Method Detail

getContext

public static NodeAuthModuleContext getContext()

Returns the current singleton instance of the Node Authentication Module Context from the ThreadLocal cache. If the ThreadLocal cache has not been initialized or does not contain this context, then create and initialize module context, register in the ThreadLocal and return the new instance.

Returns:

Context singleton

getConfig

public NodeAuthModuleConfig getConfig()

Overrides:

getConfig in class AbstractModuleContext

getContextId

public String getContextId()

Specified by:

getContextId in class AbstractModuleContext

getSocketHandler

public final SocketHandler getSocketHandler()

Gets the socket creation handler set in this context for creating secure and non-secured sockets

Returns:

The context's socket handler

getSecurityDomainManager

public final SecurityDomainManager getSecurityDomainManager()

Gets the security domain manager that stores and associates domain configurations to fixed URLs.

Returns:

The context's security domain manager

setTLSEnabled

public void setTLSEnabled(boolean enableTLS)

Sets if TLS connections are currently allowed

Parameters:

enableTLS - Allow TLS connections (true) or not (false)

isTLSEnabled

public boolean isTLSEnabled()

Returns if TLS connections are currently allowed

Returns:

If TLS connections are allowed

setNonTLSConnectionsPermitted

public void setNonTLSConnectionsPermitted(boolean enableNonTLS)

Sets if non-TLS connections are permitted

Parameters:

enableNonTLS - Allow non-TLS connections (true) or not (false)

isNonTLSConnectionsPermitted

public boolean isNonTLSConnectionsPermitted()

Returns if non-TLS connections can be created. If this is false, and a non-secure socket is created, then an exception is thrown

Returns:

Whether non-TLS sockets can be created