public static final class DOFConnection.Config.BuilderHub
extends java.lang.Object
DOFConnection.Type.HUB
connection configurations.
These configurations are immutable once built, and so
the builder allows them to be created (and modified) up until they are built.Constructor and Description |
---|
BuilderHub(DOFGroupAddress groupAddress,
DOFCredentials credentials)
Construct a new builder based on an address an credentials.
|
Modifier and Type | Method and Description |
---|---|
DOFConnection.Config |
build()
Return a configuration based on the current settings of the builder.
|
DOFConnection |
createConnection(DOF dof)
This is a convenience method for creating the connection with the implied
DOFConnection.Config . |
DOFConnection |
createConnection(DOF dof,
DOFAddress hubAddress)
This is a convenience method for creating the connection with the implied
DOFConnection.Config . |
DOFConnection.Config.BuilderHub |
setAddress(DOFGroupAddress groupAddress)
Set the target address of the connection.
|
T |
setAuditorListener(DOFAuditListener auditListener)
Set this connection's audit listener.
|
T |
setBridge(DOFOperation.Bridge.Config bridge)
Set the bridge of the connection.
|
T |
setCredentials(DOFCredentials credentials)
Set the credentials of the connection.
|
DOFConnection.Config.BuilderHub |
setHubAddress(DOFAddress hubAddress)
Set the hubAddress to be used by
createConnection(DOF) . |
DOFConnection.Config.BuilderHub |
setMaxReceiveSilence(int maxReceiveSilence)
Set the maximum receive silence.
|
T |
setName(java.lang.String name)
Set this connection's name to be used in logging.
|
DOFConnection.Config.BuilderHub |
setProtocolNegotiator(DOFProtocolNegotiator negotiator)
Set the protocol negotiator to use on the connection.
|
T |
setReceiveFilter(DOFOperation.Filter receiveFilter)
Set the receive filter of the connection.
|
DOFConnection.Config.BuilderHub |
setSecurityDesire(DOF.SecurityDesire desire)
Set this connection's security desire.
|
T |
setSendFilter(DOFOperation.Filter sendFilter)
Set the send filter of the connection.
|
T |
setStreamRequestListener(DOFConnection.StreamRequestListener listener)
Set this connection's stream-request listener.
|
T |
setTransportConfig(org.opendof.core.transport.ConnectionConfig config)
Set the transport configuration associated with the connection.
|
T |
setTunnelDomains(boolean isTunnelDomains)
Set whether or not the connection is allowed to tunnel remote domains.
|
public BuilderHub(DOFGroupAddress groupAddress, DOFCredentials credentials)
groupAddress
- The address to connect to. Must not be null.credentials
- The credentials for this connection.public DOFConnection.Config.BuilderHub setAddress(DOFGroupAddress groupAddress)
groupAddress
- The target address of the connection. Must not be null.public DOFConnection.Config.BuilderHub setProtocolNegotiator(DOFProtocolNegotiator negotiator)
DOFProtocolNegotiator.createDefault()
.negotiator
- The protocol negotiator to use on the connection. null
means default.public DOFConnection.Config.BuilderHub setSecurityDesire(DOF.SecurityDesire desire)
desire
- The desire to set on this connection. null
means default.public DOFConnection.Config.BuilderHub setMaxReceiveSilence(int maxReceiveSilence)
DOFConnection.Config.DEFAULT_HUB_POINT_MAX_RECEIVE_SILENCE
.
Optimally, the max receive silence should be much greater (at least 20 seconds greater) than the max send silence on the other end of the connection.
This does not apply to connections of type DOFConnection.Type.GROUP
or DOFConnection.Type.POINT
.maxReceiveSilence
- The maximum receive silence in milliseconds. Must be greater than zero.public DOFConnection.Config.BuilderHub setHubAddress(DOFAddress hubAddress)
createConnection(DOF)
. This is a convenience so that you don't have to keep the address
around until createConnection is called. The default is null, so if this method is not called, createConnection(DOF) will throw
IllegalArgumentException.
This method is only useful if you plan on calling createConnection much later and don't want to pass around the hubAddress
parameter you will need to call createConnection. If that is not your use case, then just call createConnection(DOF, DOFAddress)
.hubAddress
- The hubAddress.createConnection(DOF)
public DOFConnection createConnection(DOF dof)
DOFConnection.Config
.
The hubAddress must have been previously set explicitly with setHubAddress(org.opendof.core.oal.DOFAddress)
.
This method signature is only useful if you plan on calling it much later than the constructor and don't want to pass around the hubAddress
parameter you will need to call createConnection(DOF, DOFAddress)
. If that is not your use case, then just call
createConnection(DOF, DOFAddress) or the setter.dof
- The DOF to use to create the connection.setHubAddress(DOFAddress)
public DOFConnection createConnection(DOF dof, DOFAddress hubAddress)
DOFConnection.Config
.dof
- The DOF to use to create the connection.hubAddress
- The server address of the hub. Usually, you will use this: InetTransport.createAddress("0.0.0.0", hubPort)
public T setTunnelDomains(boolean isTunnelDomains)
isTunnelDomains
- Whether or not the connection is allowed to tunnel remote domains.public T setCredentials(DOFCredentials credentials)
credentials
- The credentials for this connection.public T setBridge(DOFOperation.Bridge.Config bridge)
bridge
- The bridge for this connection. null
means none (default).public T setSendFilter(DOFOperation.Filter sendFilter)
sendFilter
- The connection's send filter. null
means none.public T setReceiveFilter(DOFOperation.Filter receiveFilter)
receiveFilter
- The connection's receive filter. null
means none.public T setTransportConfig(org.opendof.core.transport.ConnectionConfig config)
config
- The transport configuration associated with the connection. null
means none(default).public T setName(java.lang.String name)
name
- The connection's name.public T setAuditorListener(DOFAuditListener auditListener)
auditListener
- The connection's audit listener. null
means none (default).public T setStreamRequestListener(DOFConnection.StreamRequestListener listener)
listener
- The connection's stream-request listener. Pass null to clear the listener.public DOFConnection.Config build()