net.sf.eBus.config

Class EConfigure.AbstractBuilder<T extends EConfigure.AbstractBuilder>

java.lang.Object

net.sf.eBus.config.EConfigure.AbstractBuilder<T>

Type Parameters:

T - builder subclass.

Direct Known Subclasses:

EConfigure.ConnectionBuilder, EConfigure.ServerBuilder

Enclosing class:

EConfigure

public abstract static class EConfigure.AbstractBuilder<T extends EConfigure.AbstractBuilder>
extends Object

Base class for EConfigure.ServerBuilder and EConfigure.ConnectionBuilder, containing the properties common to both.

Author:

Charles W. Rapp

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteOrder	mByteOrder Code and decode messages in this byte order.
protected boolean	mCanPause Set to true if remote connections may be paused.
protected long	mHbDelay Send a heartbeat message after this many milliseconds of inbound message inactivity.
protected long	mHbReplyDelay The number of milliseconds the far-end has to respond to a heartbeat.
protected int	mInputBufferSize Maximum input buffer size.
protected boolean	mLoaderFlag Set to true if this builder is used when loading a configuration.
protected int	mMsgQueueSize Maximum eBus message outbound queue size for remote connections.
protected String	mName Unique service or connection name.
protected int	mOutputBufferSize Maximum output buffer size.
protected EConfigure.PauseConfig	mPauseConfig Contains the pause parameters.
protected SSLContext	mSSLContext The SSL/TLS context used for a secure TCP connection.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBuilder() Creates a new abstract configuration builder.

Method Summary

Modifier and Type	Method and Description
ByteOrder	byteOrder() Returns the configured byte order.
T	byteOrder(ByteOrder byteOrder) Sets the byte order used by the connection.
boolean	canPause() Returns true if accepted connections may be paused; false means pause requests will be rejected.
T	canPause(boolean flag) Sets a flag specifying whether accepted connections may be paused (true) or not.
protected T	configuration(EConfigure.AbstractConfig config) Copies the values found in config to this configuration.
EConfigure.ConnectionType	connectionType() Returns the underlying channel type.
T	connectionType(EConfigure.ConnectionType connType) Sets the underlying channel type.
long	heartbeatDelay() Returns the configured heartbeat delay.
T	heartbeatDelay(long delay) Sets the heartbeat delay used for the connection.
long	heartbeatReplyDelay() Returns the configured heartbeat reply delay.
T	heartbeatReplyDelay(long delay) Sets the heartbeat reply delay used for the connection.
int	inputBufferSize() Returns the configured input buffer size.
T	inputBufferSize(int size) Sets the input buffer size for the connection.
protected T	loaderFlag(boolean flag) Sets the loader flag to the given value.
int	messageQueueSize() Returns the configured message queue size.
T	messageQueueSize(int size) Sets the maximum queue size for the connection.
String	name() Returns the configuration name.
T	name(String name) Sets the service/connection name.
int	outputBufferSize() Returns the configured output buffer size.
T	outputBufferSize(int size) Sets the output buffer size for the connection.
EConfigure.PauseConfig	pauseConfig() Returns the pause configuration.
T	pauseConfig(EConfigure.PauseConfig pc) Set the pause configuration for the connection.
SSLContext	sslContext() Returns the configured SSL context.
T	sslContext(SSLContext context) Sets the SSL/TLS context used by a secure location.
protected void	validate() Validates builder arguments are correctly set, throwing the appropriate exception if validation fails.

Methods inherited from class java.lang.Object

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

Field Detail

mName

protected String mName

Unique service or connection name.

mInputBufferSize

protected int mInputBufferSize

Maximum input buffer size. May be overridden by SSLSession.getApplicationBufferSize() when using a secure TCP connection.

mOutputBufferSize

protected int mOutputBufferSize

Maximum output buffer size. May be override by SSLSession.getPacketBufferSize() when using a secure TCP connection.

mByteOrder

protected ByteOrder mByteOrder

Code and decode messages in this byte order.

mMsgQueueSize

protected int mMsgQueueSize

Maximum eBus message outbound queue size for remote connections. When the queue outbound message count exceeds this size, the remote connection is automatically closed and the outbound messages discarded.

mHbDelay

protected long mHbDelay

Send a heartbeat message after this many milliseconds of inbound message inactivity.

mHbReplyDelay

protected long mHbReplyDelay

The number of milliseconds the far-end has to respond to a heartbeat. If the response is not received after this many milliseconds, the remote connection is automatically closed.

mSSLContext

protected SSLContext mSSLContext

The SSL/TLS context used for a secure TCP connection.

mCanPause

protected boolean mCanPause

Set to true if remote connections may be paused.

mPauseConfig

protected EConfigure.PauseConfig mPauseConfig

Contains the pause parameters. Will be null if mCanPause is false.

mLoaderFlag

protected boolean mLoaderFlag

Set to true if this builder is used when loading a configuration. This flag is used to detect when a secure TCP session is defined in a configuration as opposed to built by an application. If so, then the session definition is not required to define the SSL context.

Constructor Detail

AbstractBuilder

protected AbstractBuilder()

Creates a new abstract configuration builder.

Method Detail

name

public final String name()

Returns the configuration name. Returns null if name is not set.

Returns:

configuration name.

connectionType

public final EConfigure.ConnectionType connectionType()

Returns the underlying channel type.

Returns:

channel type.

inputBufferSize

public final int inputBufferSize()

Returns the configured input buffer size.

Returns:

input buffer size.

outputBufferSize

public final int outputBufferSize()

Returns the configured output buffer size.

Returns:

output buffer size.

byteOrder

public final ByteOrder byteOrder()

Returns the configured byte order.

Returns:

byte order.

messageQueueSize

public final int messageQueueSize()

Returns the configured message queue size.

Returns:

message queue size.

heartbeatDelay

public final long heartbeatDelay()

Returns the configured heartbeat delay.

Returns:

heartbeat delay.

heartbeatReplyDelay

public final long heartbeatReplyDelay()

Returns the configured heartbeat reply delay.

Returns:

heartbeat reply delay.

sslContext

public final SSLContext sslContext()

Returns the configured SSL context. Returns null if connectionType() is not EConfigure.ConnectionType.SECURE_TCP.

Returns:

SSL context instance.

canPause

public boolean canPause()

Returns true if accepted connections may be paused; false means pause requests will be rejected.

Returns:

true if pausing is allowed.

pauseConfig

public EConfigure.PauseConfig pauseConfig()

Returns the pause configuration. If canPause() returns false, then returns null.

Returns:

pause configuration if accepted connections may be paused and null if pausing is not allowed.

name

public final T name(String name)

Sets the service/connection name.

Parameters:

name - service/connection name.

Returns:

this service/connection builder.

Throws:

com.typesafe.config.ConfigException - if name is null or empty.

connectionType

public final T connectionType(EConfigure.ConnectionType connType)

Sets the underlying channel type.

Parameters:

connType - channel type.

Returns:

this service/connection builder.

Throws:

com.typesafe.config.ConfigException - if connType is null.

inputBufferSize

public final T inputBufferSize(int size)

Sets the input buffer size for the connection. If size is zero, then the default input buffer size is used.

Parameters:

size - connection input buffer size.

Returns:

this service/connection builder.

Throws:

com.typesafe.config.ConfigException - if size < zero.

outputBufferSize

public final T outputBufferSize(int size)

Sets the output buffer size for the connection. If size is zero, then the default output buffer size is used.

Parameters:

size - accepted connection output buffer size.

Returns:

this service/connection builder.

Throws:

com.typesafe.config.ConfigException - if size < zero.

byteOrder

public final T byteOrder(ByteOrder byteOrder)

Sets the byte order used by the connection.

Parameters:

byteOrder - connection serialize and de-serialize messages using this byte order.

Returns:

this service/connection builder.

Throws:

com.typesafe.config.ConfigException - if byteOrder is nuill.

messageQueueSize

public final T messageQueueSize(int size)

Sets the maximum queue size for the connection. When the message queue size reaches this maximum, the connection is automatically closed. If zero, then the default maximum queue size is used.

Parameters:

size - message queue maximum size.

Returns:

this service/connection builder.

Throws:

com.typesafe.config.ConfigException - if size < zero.

heartbeatDelay

public final T heartbeatDelay(long delay)

Sets the heartbeat delay used for the connection. If no message is received after delay milliseconds, then a heartbeat is sent. If delay is zero, then heartbeating is turned off.

Parameters:

delay - millisecond heartbeat rate.

Returns:

this service/connection builder.

Throws:

com.typesafe.config.ConfigException - if delay < zero.

heartbeatReplyDelay

public final T heartbeatReplyDelay(long delay)

Sets the heartbeat reply delay used for the connection. The remote eBus application has this many milliseconds to reply to a heartbeat. If no reply is received after delay milliseconds, the connection is closed. This value is ignored if the heartbeat delay is zero.

Parameters:

delay - millisecond heartbeat reply delay.

Returns:

this service/connection builder.

Throws:

com.typesafe.config.ConfigException - if delay < zero.

sslContext

public final T sslContext(SSLContext context)

Sets the SSL/TLS context used by a secure location. This should be called only if the connection type is set to EConfigure.ConnectionType.SECURE_TCP.

Parameters:

context - secure TCP context.

Returns:

this server/connection builder.

Throws:

com.typesafe.config.ConfigException - if context is null.

canPause

public final T canPause(boolean flag)

Sets a flag specifying whether accepted connections may be paused (true) or not.

Parameters:

flag - pause-able connection flag.

Returns:

this connection builder.

pauseConfig

public final T pauseConfig(EConfigure.PauseConfig pc)

Set the pause configuration for the connection.

canPause(boolean) must be set to true before setting the pause configuration.

Parameters:

pc - pause configuration

Returns:

this server/connection builder.

Throws:

com.typesafe.config.ConfigException - if canPause() returns false (meaning the connection cannot be pause) or if pc is null.

configuration

protected T configuration(EConfigure.AbstractConfig config)

Copies the values found in config to this configuration. This method is used to modify an existing immutable configuration.

Parameters:

config - copy this configuration's values.

Returns:

this server/connection builder.

loaderFlag

protected final T loaderFlag(boolean flag)

Sets the loader flag to the given value.

Parameters:

flag - loader flag value.

Returns:

this server/connection builder.

validate

protected void validate()

Validates builder arguments are correctly set, throwing the appropriate exception if validation fails.

Throws:

com.typesafe.config.ConfigException - if service name or connection type is not set, if SSL context not provided for a secure connection, or if SSL context provided for a non-secure connection.