NodeAuthModuleConfig (OpenHealthTools(OHT) ATNA NodeAuth 3.1.2 API)

java.lang.Object
- org.openhealthtools.ihe.atna.context.AbstractModuleConfig
- - org.openhealthtools.ihe.atna.nodeauth.context.NodeAuthModuleConfig

All Implemented Interfaces:

Serializable, Cloneable
```
public class NodeAuthModuleConfig
extends AbstractModuleConfig
```
Module Context Configuration manager for the Node Authentication Module.

Author:

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`NODEAUTH_CONNECT_TIMEOUT_KEY` Config reference key for the number of milliseconds before the socket times out while connecting
`static String`	`NODEAUTH_NON_TLS_CONNECTIONS_PERMITTED_KEY` Config reference key to enable/disable non-TLS connections
`static String`	`NODEAUTH_SOCKET_RETRIES_KEY` Config reference key for the number of socket retries before failure
`static String`	`NODEAUTH_SOCKET_RETRY_WAIT_KEY` Config reference key for the number of milliseconds between each retry
`static String`	`NODEAUTH_SOCKET_TIMEOUT_KEY` Config reference key for the number of milliseconds before the socket times out
`static String`	`NODEAUTH_TLS_ENABLED_KEY` Config reference key for TLS Enable/Disable

Constructor Summary

Constructors
Constructor and Description

NodeAuthModuleConfig()
Default constructor for the Node Authentication Module configuration

Constructors
Constructor and Description
`NodeAuthModuleConfig()` Default constructor for the Node Authentication Module configuration

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getConnectTimeout()` Gets the number of milliseconds to wait before a socket times out
`int`	`getSocketRetries()` Gets the number of times to try opening a socket before giving up
`int`	`getSocketRetryWait()` Gets the number of milliseconds to wait between each connect attempt if the previous failed
`int`	`getSocketTimeout()` Gets the number of milliseconds to wait before a socket times out
`boolean`	`isNonTLSConnectionsPermitted()` Returns if non-TLS connections can be created.
`boolean`	`isTLSEnabled()` Returns if TLS connections are currently allowed
`void`	`setConnectTimeout(int ms)` Sets the number of milliseconds to wait before a socket times out while connecting
`void`	`setNonTLSConnectionsPermitted(boolean enable)` Sets if non-TLS connections are permitted
`void`	`setSocketRetries(int count)` Sets the number of times to try opening a socket before giving up
`void`	`setSocketRetryWait(int ms)` Sets the number of milliseconds to wait between each connect attempt if the previous failed
`void`	`setSocketTimeout(int ms)` Sets the number of milliseconds to wait before a socket times out
`void`	`setTLSEnabled(boolean enable)` Sets if TLS connections are currently allowed

Methods inherited from class org.openhealthtools.ihe.atna.context.AbstractModuleConfig
getOption, getProperties, setOption

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NODEAUTH_TLS_ENABLED_KEY
```
public static final String NODEAUTH_TLS_ENABLED_KEY
```
    Config reference key for TLS Enable/Disable
    
    See Also:
    
    Constant Field Values
  - NODEAUTH_NON_TLS_CONNECTIONS_PERMITTED_KEY
```
public static final String NODEAUTH_NON_TLS_CONNECTIONS_PERMITTED_KEY
```
    Config reference key to enable/disable non-TLS connections
    
    See Also:
    
    Constant Field Values
  - NODEAUTH_SOCKET_RETRIES_KEY
```
public static final String NODEAUTH_SOCKET_RETRIES_KEY
```
    Config reference key for the number of socket retries before failure
    
    See Also:
    
    Constant Field Values
  - NODEAUTH_SOCKET_RETRY_WAIT_KEY
```
public static final String NODEAUTH_SOCKET_RETRY_WAIT_KEY
```
    Config reference key for the number of milliseconds between each retry
    
    See Also:
    
    Constant Field Values
  - NODEAUTH_SOCKET_TIMEOUT_KEY
```
public static final String NODEAUTH_SOCKET_TIMEOUT_KEY
```
    Config reference key for the number of milliseconds before the socket times out
    
    See Also:
    
    Constant Field Values
  - NODEAUTH_CONNECT_TIMEOUT_KEY
```
public static final String NODEAUTH_CONNECT_TIMEOUT_KEY
```
    Config reference key for the number of milliseconds before the socket times out while connecting
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NodeAuthModuleConfig
```
public NodeAuthModuleConfig()
```
    Default constructor for the Node Authentication Module configuration
- Method Detail
  - isTLSEnabled
```
public boolean isTLSEnabled()
```
    Returns if TLS connections are currently allowed
    
    Returns:
    
    If TLS connections are allowed
  - setTLSEnabled
```
public void setTLSEnabled(boolean enable)
```
    Sets if TLS connections are currently allowed
    
    Parameters:
    
    enable - Allow 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
  - setNonTLSConnectionsPermitted
```
public void setNonTLSConnectionsPermitted(boolean enable)
```
    Sets if non-TLS connections are permitted
    
    Parameters:
    
    enable - Allow non-TLS connections (true) or not (false)
  - getSocketRetries
```
public int getSocketRetries()
```
    Gets the number of times to try opening a socket before giving up
    
    Returns:
    
    The number of connect tries
  - setSocketRetries
```
public void setSocketRetries(int count)
```
    Sets the number of times to try opening a socket before giving up
    
    Parameters:
    
    count - The number of tries
  - getSocketRetryWait
```
public int getSocketRetryWait()
```
    Gets the number of milliseconds to wait between each connect attempt if the previous failed
    
    Returns:
    
    The wait time in milliseconds between attempts
  - setSocketRetryWait
```
public void setSocketRetryWait(int ms)
```
    Sets the number of milliseconds to wait between each connect attempt if the previous failed
    
    Parameters:
    
    ms - The number of milliseconds to wait
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Gets the number of milliseconds to wait before a socket times out
    
    Returns:
    
    The socket timeout in milliseconds
  - setSocketTimeout
```
public void setSocketTimeout(int ms)
```
    Sets the number of milliseconds to wait before a socket times out
    
    Parameters:
    
    ms - The socket timeout in milliseconds
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Gets the number of milliseconds to wait before a socket times out
    
    Returns:
    
    The socket timeout in milliseconds
  - setConnectTimeout
```
public void setConnectTimeout(int ms)
```
    Sets the number of milliseconds to wait before a socket times out while connecting
    
    Parameters:
    
    ms - The socket connect timeout in milliseconds

Class NodeAuthModuleConfig

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

NODEAUTH_TLS_ENABLED_KEY

NODEAUTH_NON_TLS_CONNECTIONS_PERMITTED_KEY

NODEAUTH_SOCKET_RETRIES_KEY

NODEAUTH_SOCKET_RETRY_WAIT_KEY

NODEAUTH_SOCKET_TIMEOUT_KEY

NODEAUTH_CONNECT_TIMEOUT_KEY

Constructor Detail

NodeAuthModuleConfig

Method Detail

isTLSEnabled

setTLSEnabled

isNonTLSConnectionsPermitted

setNonTLSConnectionsPermitted

getSocketRetries

setSocketRetries

getSocketRetryWait

setSocketRetryWait

getSocketTimeout

setSocketTimeout

getConnectTimeout

setConnectTimeout