EConfigure.AbstractBuilder (eBus Configuration 5.0.1 API)

java.lang.Object
- net.sf.eBus.config.EConfigure.AbstractBuilder

Direct Known Subclasses:

EConfigure.ConnectionBuilder, EConfigure.ServerBuilder

Enclosing class:

EConfigure
```
public abstract static class 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 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 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 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.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteOrder`	`byteOrder()` Returns the configured byte order.
`EConfigure.ConnectionType`	`connectionType()` Returns the underlying channel type.
`long`	`heartbeatDelay()` Returns the configured heartbeat delay.
`long`	`heartbeatReplyDelay()` Returns the configured heartbeat reply delay.
`int`	`inputBufferSize()` Returns the configured input buffer size.
`int`	`messageQueueSize()` Returns the configured message queue size.
`String`	`name()` Returns the configuration name.
`int`	`outputBufferSize()` Returns the configured output buffer size.
`protected void`	`setByteOrder(ByteOrder byteOrder)` Sets the byte order used by accepted TCP connections.
`protected void`	`setConnectionType(EConfigure.ConnectionType connType)` Sets the channel type to the given value.
`protected void`	`setHeartbeatDelay(long delay)` Sets the heartbeat delay used for accepted TCP connections.
`protected void`	`setHeartbeatReplyDelay(long delay)` Sets the heartbeat reply delay used for accepted TCP connections.
`protected void`	`setInputBufferSize(int size)` Sets the input buffer size for all accepted TCP connections.
`protected void`	`setMessageQueueSize(int size)` Sets the maximum queue size for accepted TCP connections.
`protected void`	`setName(String name)` Sets the service name.
`protected void`	`setOutputBufferSize(int size)` Sets the output buffer size for all accept TCP connections.
`protected void`	`setSSLContext(SSLContext context)` Sets the SSL context instance.
`SSLContext`	`sslContext()` Returns the configured SSL context.
`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.
- 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.
  - setName
```
protected final void setName(String name)
```
    Sets the service name.
    
    Parameters:
    
    name - service name.
    
    Throws:
    
    NullPointerException - if name is null.
    
    IllegalArgumentException - if name is empty.
  - setConnectionType
```
protected final void setConnectionType(EConfigure.ConnectionType connType)
```
    Sets the channel type to the given value.
    
    Parameters:
    
    connType - underlying channel is of this type.
  - setInputBufferSize
```
protected final void setInputBufferSize(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.
    
    Throws:
    
    IllegalArgumentException - if size < zero.
  - setOutputBufferSize
```
protected final void setOutputBufferSize(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.
    
    Throws:
    
    IllegalArgumentException - if size < zero.
  - setByteOrder
```
protected final void setByteOrder(ByteOrder byteOrder)
```
    Sets the byte order used by accepted TCP connections.
    
    Parameters:
    
    byteOrder - accepted connections serialize and de-serialize messages using this byte order.
    
    Throws:
    
    NullPointerException - if byteOrder is nuill.
  - setMessageQueueSize
```
protected final void setMessageQueueSize(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 there is no maximum queue size and the queue is allowed to grow indefinitely.
    
    Parameters:
    
    size - message queue maximum size.
    
    Throws:
    
    IllegalArgumentException - if size < zero.
  - setHeartbeatDelay
```
protected final void setHeartbeatDelay(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.
    
    Throws:
    
    IllegalArgumentException - if delay < zero.
  - setHeartbeatReplyDelay
```
protected final void setHeartbeatReplyDelay(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.
    
    Throws:
    
    IllegalArgumentException - if delay < zero.
  - setSSLContext
```
protected final void setSSLContext(SSLContext context)
```
    Sets the SSL context instance. Required if connection type is EConfigure.ConnectionType.SECURE_TCP. If an SSL context is provided for non-secure connection types, then validation will fail.
    
    Parameters:
    
    context - SSL context.
    
    Throws:
    
    NullPointerException - if context is null.
  - validate
```
protected void validate()
```
    Validates builder arguments are correctly set, throwing the appropriate exception if validation fails.
    
    Throws:
    
    NullPointerException - if service name or connection type is not set or if SSL context not provided for a secure connection.
    
    IllegalArgumentException - if SSL context provided for a non-secure connection.

Class EConfigure.AbstractBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mName

mInputBufferSize

mOutputBufferSize

mByteOrder

mMsgQueueSize

mHbDelay

mHbReplyDelay

mSSLContext

Constructor Detail

AbstractBuilder

Method Detail

name

connectionType

inputBufferSize

outputBufferSize

byteOrder

messageQueueSize

heartbeatDelay

heartbeatReplyDelay

sslContext

setName

setConnectionType

setInputBufferSize

setOutputBufferSize

setByteOrder

setMessageQueueSize

setHeartbeatDelay

setHeartbeatReplyDelay

setSSLContext

validate