net.sf.eBus.config

Class EConfigure.ServerBuilder

java.lang.Object

net.sf.eBus.config.EConfigure.AbstractBuilder

net.sf.eBus.config.EConfigure.ServerBuilder

Enclosing class:

EConfigure

public static final class EConfigure.ServerBuilder
extends EConfigure.AbstractBuilder

Constructs an EConfigure.Service instance based on the parameters set via this builder's API. The minimally allowed configuration is the service name, connection type and port. The remaining parameters are set to the following defaults:

• connection type: EConfigure.ConnectionType.TCP - plain text TCP connection.
• address filter: null - no address filter applied.
• input buffer size: zero - use system default buffer size.
• output buffer size: zero - use system default buffer size.
• byte order: little-endian.
• maximum message queue size: zero - unlimited queue size.
• service selector thread: AsyncChannel.defaultSelector.
• accepted connection select thread: AsyncChannel.defaultSelector.
• heartbeat millisecond delay: zero - heartbeating off.
• heartbeat millisecond reply delay: zero - wait indefinitely for a reply.

If either the service name or port are not set, then build() will throw an exception.

Example building an EServer

final AddressFilter filter = ...;
final SSLContext secureContext = ...;
final EConfigure.ServerBuilder builder = EConfigure.serverBuilder();

EServer.openServer(builder.name("AppServer")
                          .port(6789)
                          .connectionType(EConfigure.ConnectionType.SECURE_TCP)
                          .sslContext(secureContext)
                          .addressFilter(filter)
                          .inputBufferSize(1_024)
                          .outputBufferSize(1_024)
                          .byteOrder(ByteOrder.BIG_ENDIAN)
                          .messageQueueSize(10_000)
                          .serviceSelector("svcSelector")
                          .connectionSelector("connSelector")
                          .heartbeatDelay(60_000L)
                          .heartbeatReplyDelay(30_000L)
                          .build());

Author:

Charles W. Rapp

See Also:

EConfigure.ConnectionBuilder

Field Summary

Fields inherited from class net.sf.eBus.config.EConfigure.AbstractBuilder

mByteOrder, mHbDelay, mHbReplyDelay, mInputBufferSize, mMsgQueueSize, mName, mOutputBufferSize, mSSLContext

Method Summary

Modifier and Type	Method and Description
AddressFilter	addressFilter() Returns the configured address filter.
EConfigure.ServerBuilder	addressFilter(AddressFilter filter) Sets the optional service address filter.
EConfigure.Service	build() Returns the eBus service configuration built from the previously set parameters.
EConfigure.ServerBuilder	byteOrder(ByteOrder byteOrder) Sets the byte order used by accepted TCP connections.
String	connectionSelector() Returns the network selector information used for accepted connections.
EConfigure.ServerBuilder	connectionSelector(String selector) Sets the selector used for accepted TCP connections.
EConfigure.ServerBuilder	connectionType(EConfigure.ConnectionType connType) Sets the underlying channel type.
EConfigure.ServerBuilder	heartbeatDelay(long delay) Sets the heartbeat delay used for accepted TCP connections.
EConfigure.ServerBuilder	heartbeatReplyDelay(long delay) Sets the heartbeat reply delay used for accepted TCP connections.
EConfigure.ServerBuilder	inputBufferSize(int size) Sets the input buffer size for all accepted TCP connections.
EConfigure.ServerBuilder	messageQueueSize(int size) Sets the maximum queue size for accepted TCP connections.
EConfigure.ServerBuilder	name(String name) Sets the service name.
EConfigure.ServerBuilder	outputBufferSize(int size) Sets the output buffer size for all accept TCP connections.
int	port() Returns the configured TCP port.
EConfigure.ServerBuilder	port(int port) Sets the service TCP port.
String	serviceSelector() Returns the network selector information used for the eBus service.
EConfigure.ServerBuilder	serviceSelector(String selector) Sets the selector used for the service connection.
EConfigure.ServerBuilder	sslContext(SSLContext context) Sets the SSL/TLS context used by a secure location.
protected void	validate() Validates the builder parameters.

Methods inherited from class net.sf.eBus.config.EConfigure.AbstractBuilder

byteOrder, connectionType, heartbeatDelay, heartbeatReplyDelay, inputBufferSize, messageQueueSize, name, outputBufferSize, setByteOrder, setConnectionType, setHeartbeatDelay, setHeartbeatReplyDelay, setInputBufferSize, setMessageQueueSize, setName, setOutputBufferSize, setSSLContext, sslContext

Methods inherited from class java.lang.Object

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

Method Detail

port

public int port()

Returns the configured TCP port.

Returns:

TCP port.

addressFilter

public AddressFilter addressFilter()

Returns the configured address filter. Returns null if the address filter is not set.

Returns:

address filter.

serviceSelector

public String serviceSelector()

Returns the network selector information used for the eBus service.

Returns:

network selector information.

connectionSelector

public String connectionSelector()

Returns the network selector information used for accepted connections.

Returns:

network selector information.

name

public EConfigure.ServerBuilder name(String name)

Sets the service name.

Parameters:

name - service name.

Returns:

this service builder.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if name is empty.

connectionType

public EConfigure.ServerBuilder connectionType(EConfigure.ConnectionType connType)

Sets the underlying channel type.

Parameters:

connType - channel type.

Returns:

this service builder.

Throws:

NullPointerException - if connType is null.

port

public EConfigure.ServerBuilder port(int port)

Sets the service TCP port.

Parameters:

port - service TCP port.

Returns:

this service builder.

Throws:

IllegalArgumentException - if port is not a valid TCP address.

addressFilter

public EConfigure.ServerBuilder addressFilter(AddressFilter filter)

Sets the optional service address filter.

Parameters:

filter - the optional address filter. May be null.

Returns:

this service builder.

inputBufferSize

public EConfigure.ServerBuilder inputBufferSize(int size)

Sets the input buffer size for all accepted TCP connections. If size is zero, then the default input buffer size is used.

Parameters:

size - accepted connection input buffer size.

Returns:

this service builder.

Throws:

IllegalArgumentException - if size < zero.

outputBufferSize

public EConfigure.ServerBuilder outputBufferSize(int size)

Sets the output buffer size for all accept TCP connections. If size is zero, then the default output buffer size is used.

Parameters:

size - accepted connection output buffer size.

Returns:

this service builder.

Throws:

IllegalArgumentException - if size < zero.

byteOrder

public EConfigure.ServerBuilder byteOrder(ByteOrder byteOrder)

Sets the byte order used by accepted TCP connections.

Parameters:

byteOrder - accepted connections serialize and de-serialize messages using this byte order.

Returns:

this service builder.

Throws:

NullPointerException - if byteOrder is nuill.

messageQueueSize

public EConfigure.ServerBuilder messageQueueSize(int size)

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

Parameters:

size - message queue maximum size.

Returns:

this service builder.

Throws:

IllegalArgumentException - if size < zero.

serviceSelector

public EConfigure.ServerBuilder serviceSelector(String selector)

Sets the selector used for the service connection.

Parameters:

selector - eBus selector name.

Returns:

this service builder.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if name is an empty string or not a known selector.

connectionSelector

public EConfigure.ServerBuilder connectionSelector(String selector)

Sets the selector used for accepted TCP connections.

Parameters:

selector - eBus selector name.

Returns:

this service builder.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if name is an empty string or not a known selector.

heartbeatDelay

public EConfigure.ServerBuilder heartbeatDelay(long delay)

Sets the heartbeat delay used for accepted TCP connections. 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 builder.

Throws:

IllegalArgumentException - if delay < zero.

heartbeatReplyDelay

public EConfigure.ServerBuilder heartbeatReplyDelay(long delay)

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

Parameters:

delay - millisecond heartbeat reply delay.

Returns:

this service builder.

Throws:

IllegalArgumentException - if delay < zero.

sslContext

public EConfigure.ServerBuilder 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 connection builder.

Throws:

NullPointerException - if context is null.

build

public EConfigure.Service build()

Returns the eBus service configuration built from the previously set parameters.

Returns:

an eBus service configuration.

Throws:

NullPointerException - if any service name is not set.

IllegalStateException - if service port is not set.

validate

protected void validate()

Validates the builder parameters. Called for effect only.

Overrides:

validate in class EConfigure.AbstractBuilder

Throws:

NullPointerException - if a required parameter is not set.

IllegalArgumentException - if a parameter is not set to a valid value with respect to another parameter.