org.openhealthtools.ihe.atna.nodeauth

Class SecurityDomainManager

java.lang.Object

org.openhealthtools.ihe.atna.nodeauth.SecurityDomainManager

public class SecurityDomainManager
extends Object

Thread safe repository of configurations used by the ATNA Node Authentication Context
This class is a singleton, all methods are static methods against the singleton instance. No user initiated initialization is required.

When the class is loaded, it will examine the System environment looking for the standard SSL/TLS environment variarbles. If present, they will be use to create a default SecurityDomain

• javax.net.ssl.keyStore
• javax.net.ssl.keyStorePassword

Optional settings
• javax.net.ssl.trustStore
• javax.net.ssl.trustStorePassword
• http.ciphersuites=list of suites to use. IHE recommends TLS_RSA_WITH_NULL_SHA and TLS_RSA_WITH_AES_CBC_SHA
  
• javax.net.debug
  This class also provides the control point to force TLS NOT TO BE USED for any connection. This is done with the #setTLSEnabled(boolean) method. Unless set, the default is to allow TLS.

Since:

OHF 1.0.0

Author:

Glenn Deen glenn@almaden.ibm.com

Constructor Summary

Constructors

Constructor and Description
SecurityDomainManager()

Method Summary

Modifier and Type	Method and Description
String	formatKey(String host, int port) Concatenates a host string and port integer into a "host:port" string
String	formatKey(URI uri) Converts a well-formed URI containing a hostname and port into string which allows for lookups in the Security Domain table
Set<String>	getRegisteredSecurityDomains() Returns the names of the registered security domains.
SecurityDomain	getSecurityDomain(String name) Returns the security domain with the given name.
SecurityDomain	getSecurityDomain(String host, int port)
SecurityDomain	getSecurityDomain(URI uri) Returns the SecurityDomain object registered as associated with the URI.
void	registerDefaultSecurityDomain(SecurityDomain securityDomain) Registers the properies file to be used as the default security domain.
void	registerSecurityDomain(SecurityDomain securityDomain) Registers the SecurityDomain object with the ConfigurationManager.
void	registerURItoSecurityDomain(URI uri, String name) Registers the association of the given URI to the named security domain.
void	unregisterDefaultSecurityDomain() Unregisters the default security domain, if it exists
void	unregisterURItoSecurityDomain(URI uri) Removes the URI from registered set of URI's

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityDomainManager

public SecurityDomainManager()

Method Detail

registerSecurityDomain

public void registerSecurityDomain(SecurityDomain securityDomain)

Registers the SecurityDomain object with the ConfigurationManager.

About the Security Domain name
The security domain name SecurityDomain#getName() is used as a key by subsequent calls such as {@link #registerURItoSecurityDomain(URI, String)} to associate the security properties registered here.

• The name DEFAULT is a special name name which specifies the name which will be used for a URI in the absence of a explicit name registered the URI
• Other than DEFAULT any other name is allowed, and is up to the calling application to choose.

Parameters:

securityDomain - domain to add to the configuration manager

registerDefaultSecurityDomain

public void registerDefaultSecurityDomain(SecurityDomain securityDomain)

Registers the properies file to be used as the default security domain. The security domain object is also registered under its given name taken from the SecurityDomain.getName() method.

About the Security Domain name
The security domain name is used as a key by subsequent calls such as registerURItoSecurityDomain(URI, String) to associate the security properties registered here.

• The name DEFAULT is a special domain name which specifies the domain which will be used for a URI in the absence of a explicit domain registered the URI
• Other than DEFAULT any other name is allowed, and is up to the calling application to choose.

Parameters:

securityDomain -

registerURItoSecurityDomain

public void registerURItoSecurityDomain(URI uri,
                                        String name)
                                 throws NoSecurityDomainException,
                                        URISyntaxException

Registers the association of the given URI to the named security domain. Registration is only needed when a URI needs to use a security domain other than the default domain.
If the URI was previously registered with another domain that association is replaced with this new one.

Parameters:

uri - URI to register, may not be null

name - of SecurityDomain to associate

Throws:

URISyntaxException

{@link - IllegalArgumentException If the specified domain doesn't exist, or if the URI is null

NoSecurityDomainException

unregisterURItoSecurityDomain

public void unregisterURItoSecurityDomain(URI uri)

Removes the URI from registered set of URI's

Parameters:

uri -

unregisterDefaultSecurityDomain

public void unregisterDefaultSecurityDomain()

Unregisters the default security domain, if it exists

getSecurityDomain

public SecurityDomain getSecurityDomain(String name)

Returns the security domain with the given name. Returns null if so matching domain could be found.

Parameters:

name -

Returns:

getSecurityDomain

public SecurityDomain getSecurityDomain(URI uri)
                                 throws NoSecurityDomainException,
                                        URISyntaxException

Returns the SecurityDomain object registered as associated with the URI.
If no association has been registered for the URI, then the DEFAULT SecurityDomain is returned, if a DEFAULT domain has been registered.

Parameters:

uri -

Returns:

SecurityDomain associated with the URI

Throws:

NoSecurityDomainException - if no security name has been associated with the URI

URISyntaxException

getSecurityDomain

public SecurityDomain getSecurityDomain(String host,
                                        int port)
                                 throws NoSecurityDomainException,
                                        URISyntaxException

Parameters:

host -

port -

Returns:

Throws:

NoSecurityDomainException

URISyntaxException

getRegisteredSecurityDomains

public Set<String> getRegisteredSecurityDomains()

Returns the names of the registered security domains.
The returned set is a read only unmodifiable set

Returns:

set

formatKey

public String formatKey(URI uri)
                 throws URISyntaxException

Converts a well-formed URI containing a hostname and port into string which allows for lookups in the Security Domain table

Parameters:

uri - URI to convert

Returns:

A string with "host:port" concatenated

Throws:

URISyntaxException

formatKey

public String formatKey(String host,
                        int port)
                 throws URISyntaxException

Concatenates a host string and port integer into a "host:port" string

Parameters:

host -

port -

Returns:

Throws:

URISyntaxException