org.thales.punch.netty.impl

Class NettyConfig

java.lang.Object

org.thales.punch.netty.impl.NettyConfig

public abstract class NettyConfig
extends Object

This defines the Netty related configuration default value plus a few utility methods.

Author:

dimi

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACK_CONTROL_DEFAULT_VALUE
static String	ACK_CONTROL_FRAME_VALUE
static String	ACK_CONTROL_WINDOW_VALUE
static String	CODEC_DEFAULT_VALUE
static boolean	COMPRESS_DEFAULT_VALUE
static long	CONNECT_INTERVAL_DEFAULT_VALUE
static long	CONNECT_RETRY_INTERVAL_DEFAULT_VALUE
static boolean	HTTP_COMPRESS_DEFAULT_VALUE
static int	KEEPALIVE_INTERVAL_DEFAULT_VALUE
static int	KEEPALIVE_TIMEOUT_DEFAULT_VALUE
static boolean	LUMBERJACK_COMPRESS_DEFAULT_VALUE
static int	MAX_PAYLOAD_LENGTH_DEFAULT_VALUE
static String	METRIC_PREFIX_DEFAULT_VALUE
static String	PROTO_DEFAULT_VALUE
static boolean	RAW_DEFAULT_VALUE
static String	READ_SOCKET_TIMEOUT_ACTION_DEFAULT_VALUE
static int	READ_SOCKET_TIMEOUT_DEFAULT_VALUE
static boolean	SSL_DEFAULT_VALUE
static String	SSL_PROTOCOL_DEFAULT_VALUE
static String	SSL_PROVIDER_DEFAULT_VALUE
static boolean	SSL_STRICT_CLIENT_AUTHENTICATION_DEFAULT_VALUE
static int	UDP_MAX_PAYLOAD_LENGTH_DEFAULT_VALUE
static int	UDP_RECV_BUFFER_SIZE_DEFAULT_VALUE

Method Summary

Modifier and Type	Method and Description
static org.thales.punch.settings.api.ISettingsMap	addCertificateToSettings(org.thales.punch.settings.api.ISettingsMap address) Check if ssl is set in this listeningAddress configuration.
static org.thales.punch.settings.api.ISettingsMap	addClientCertificateToSettings(org.thales.punch.settings.api.ISettingsMap address) Deprecated. this is actually not used anymore. The IKeys.SSL_CLIENT_CERTIFICATE is not documented anymore.
static org.thales.punch.settings.api.ISettingsMap	addPrivateClientKeyToSettings(org.thales.punch.settings.api.ISettingsMap listenAddress) Deprecated.
static org.thales.punch.settings.api.ISettingsMap	addPrivateKeyToSettings(org.thales.punch.settings.api.ISettingsMap listenAddress) Check if ssl is set in this listeningAddress configuration.
static org.thales.punch.settings.api.ISettingsMap	addTrustedCertificateToSettings(org.thales.punch.settings.api.ISettingsMap address) Check if ssl is set in this address settings configuration.
static String	readSslFile(String sslFilePath)

Methods inherited from class java.lang.Object

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

Field Detail

PROTO_DEFAULT_VALUE

public static final String PROTO_DEFAULT_VALUE

See Also:

Constant Field Values

READ_SOCKET_TIMEOUT_DEFAULT_VALUE

public static final int READ_SOCKET_TIMEOUT_DEFAULT_VALUE

See Also:

Constant Field Values

READ_SOCKET_TIMEOUT_ACTION_DEFAULT_VALUE

public static final String READ_SOCKET_TIMEOUT_ACTION_DEFAULT_VALUE

See Also:

Constant Field Values

MAX_PAYLOAD_LENGTH_DEFAULT_VALUE

public static final int MAX_PAYLOAD_LENGTH_DEFAULT_VALUE

See Also:

Constant Field Values

UDP_MAX_PAYLOAD_LENGTH_DEFAULT_VALUE

public static final int UDP_MAX_PAYLOAD_LENGTH_DEFAULT_VALUE

See Also:

Constant Field Values

UDP_RECV_BUFFER_SIZE_DEFAULT_VALUE

public static final int UDP_RECV_BUFFER_SIZE_DEFAULT_VALUE

See Also:

Constant Field Values

CONNECT_RETRY_INTERVAL_DEFAULT_VALUE

public static final long CONNECT_RETRY_INTERVAL_DEFAULT_VALUE

See Also:

Constant Field Values

CONNECT_INTERVAL_DEFAULT_VALUE

public static final long CONNECT_INTERVAL_DEFAULT_VALUE

See Also:

Constant Field Values

LUMBERJACK_COMPRESS_DEFAULT_VALUE

public static final boolean LUMBERJACK_COMPRESS_DEFAULT_VALUE

See Also:

Constant Field Values

HTTP_COMPRESS_DEFAULT_VALUE

public static final boolean HTTP_COMPRESS_DEFAULT_VALUE

See Also:

Constant Field Values

COMPRESS_DEFAULT_VALUE

public static final boolean COMPRESS_DEFAULT_VALUE

See Also:

Constant Field Values

SSL_PROTOCOL_DEFAULT_VALUE

public static final String SSL_PROTOCOL_DEFAULT_VALUE

See Also:

Constant Field Values

SSL_PROVIDER_DEFAULT_VALUE

public static final String SSL_PROVIDER_DEFAULT_VALUE

See Also:

Constant Field Values

SSL_STRICT_CLIENT_AUTHENTICATION_DEFAULT_VALUE

public static final boolean SSL_STRICT_CLIENT_AUTHENTICATION_DEFAULT_VALUE

See Also:

Constant Field Values

SSL_DEFAULT_VALUE

public static final boolean SSL_DEFAULT_VALUE

See Also:

Constant Field Values

CODEC_DEFAULT_VALUE

public static final String CODEC_DEFAULT_VALUE

See Also:

Constant Field Values

RAW_DEFAULT_VALUE

public static final boolean RAW_DEFAULT_VALUE

See Also:

Constant Field Values

ACK_CONTROL_DEFAULT_VALUE

public static final String ACK_CONTROL_DEFAULT_VALUE

See Also:

Constant Field Values

ACK_CONTROL_WINDOW_VALUE

public static final String ACK_CONTROL_WINDOW_VALUE

See Also:

Constant Field Values

ACK_CONTROL_FRAME_VALUE

public static final String ACK_CONTROL_FRAME_VALUE

See Also:

Constant Field Values

KEEPALIVE_INTERVAL_DEFAULT_VALUE

public static final int KEEPALIVE_INTERVAL_DEFAULT_VALUE

See Also:

Constant Field Values

KEEPALIVE_TIMEOUT_DEFAULT_VALUE

public static final int KEEPALIVE_TIMEOUT_DEFAULT_VALUE

See Also:

Constant Field Values

METRIC_PREFIX_DEFAULT_VALUE

public static final String METRIC_PREFIX_DEFAULT_VALUE

See Also:

Constant Field Values

Method Detail

readSslFile

public static String readSslFile(String sslFilePath)
                          throws IOException

Parameters:

sslFilePath - a ssl file path

Returns:

the content as a string

Throws:

IOException - if the file cannot be read

addPrivateKeyToSettings

public static org.thales.punch.settings.api.ISettingsMap addPrivateKeyToSettings(org.thales.punch.settings.api.ISettingsMap listenAddress)

Check if ssl is set in this listeningAddress configuration. If so, read the corresponding private key from the file path in set in the expected "ssl_private_key" property, and load its content in the listeningAddress settings. The original file path is removed from the setting.

This method does nothing if there is no ssl in there.

Parameters:

listenAddress - the input listenAddress potentially updated with private key

Returns:

the listening address

addPrivateClientKeyToSettings

@Deprecated
public static org.thales.punch.settings.api.ISettingsMap addPrivateClientKeyToSettings(org.thales.punch.settings.api.ISettingsMap listenAddress)

Deprecated.

Check if ssl is set in this listeningAddress configuration. If so, read the corresponding private key from the file path in set in the expected "ssl_client_private_key" property, and load its content in the listeningAddress settings. The original file path is removed from the setting.

This method does nothing if there is no ssl in there.

Parameters:

listenAddress - the input listenAddress potentially updated with private key

Returns:

the listening address

addCertificateToSettings

public static org.thales.punch.settings.api.ISettingsMap addCertificateToSettings(org.thales.punch.settings.api.ISettingsMap address)

Check if ssl is set in this listeningAddress configuration. If so, read the corresponding certificate from the file path in set in the expected "ssl_certificate" property, and load its content in the listeningAddress settings. The original file path is removed from the setting.

This method does nothing if there is no ssl in there.

Parameters:

address - the input listenAddress potentially updated with ssl key

Returns:

the listening address

addClientCertificateToSettings

@Deprecated
public static org.thales.punch.settings.api.ISettingsMap addClientCertificateToSettings(org.thales.punch.settings.api.ISettingsMap address)

Deprecated. this is actually not used anymore. The IKeys.SSL_CLIENT_CERTIFICATE is not documented anymore.

Check if ssl is set in a listening or destination address settings. If so, read the corresponding certificate from the file path in set in the expected "ssl_client_certificate" property, and load its content in the address settings. The original file path is removed from the setting.

This method does nothing if there is no ssl in there.

Parameters:

address - the destination or listening address settings potentially updated with ssl key

Returns:

the updated address settings

addTrustedCertificateToSettings

public static org.thales.punch.settings.api.ISettingsMap addTrustedCertificateToSettings(org.thales.punch.settings.api.ISettingsMap address)

Check if ssl is set in this address settings configuration. If there is in there a trusted certificate, read it from the file path in set in the expected "ssl_trusted_certificate" property, and load its content in the listeningAddress settings. The original file path is removed from the setting.

This method does nothing if there is no ssl in there.

Parameters:

address - the input listenAddress potentially updated with ssl digital certs

Returns:

the listening address