This class creates
Type.GROUP
connection configurations.
These configurations are immutable once built, and so
the builder allows them to be created (and modified) up until they are built.
Inheritance Hierarchy
org.opendof.core.oalDOFConnectionConfigBuilderSecurableDOFConnectionConfigBuilderGroup
org.opendof.core.oalDOFConnectionConfigBuilderGroup
Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax
C#
public sealed class BuilderGroup : DOFConnectionConfigBuilderSecurable<DOFConnectionConfigBuilderGroup>
The DOFConnectionConfigBuilderGroup type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | DOFConnectionConfigBuilderGroup | Construct a new builder based on a group address and credentials. |
Methods
| Name | Description | |
|---|---|---|
| build | Return a configuration based on the current settings of the builder. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| createConnection(DOF) |
This is a convenience method for creating the connection with the implied
Config
.
The unicastAddress and multicastAddress must have been previously set explicitly with
setUnicastAddress(DOFAddress)
and
setMulticastAddress(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 ucastAddress and mcastAddress
parameters you will need to call
createConnection(DOF, DOFAddress, DOFAddress)
. If that is not your use case, then just call
createConnection(DOF, DOFAddress, DOFAddress) or the 2 setters.
|
| createConnection(DOF, DOFAddress, DOFAddress) |
This is a convenience method for creating the connection with the implied
Config
.
|
| Equals | (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| setAddress | Set the target address of the connection. |
| setAuditorListener | Set this connection's audit listener. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| setBridge | Set the bridge of the connection. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| setCredentials | Set the credentials of the connection. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| setMulticastAddress |
Set the multicastAddress to be used by
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 ucastAddress and mcastAddress
parameters you will need to call createConnection. If that is not your use case, then just call
createConnection(DOF, DOFAddress, DOFAddress)
.
|
| setName | Set this connection's name to be used in logging. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| setPermissions | Set the initial permissions of the connection. |
| setPermissionsExtendAllowed |
Set whether or not the connection is allowed to request additional permissions
from the Authentication Server aside from the initial permission set.
|
| setProtocolNegotiator | Set the protocol negotiator to use on the connection. |
| setReceiveFilter | Set the receive filter of the connection. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| setSendFilter | Set the send filter of the connection. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| setStreamRequestListener | Set this connection's stream-request listener. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| setTransportConfig | Set the transport configuration associated with the connection. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| setTunnelDomains | Set whether or not the connection is allowed to tunnel remote domains. (Inherited from DOFConnectionConfigBuilderSecurableT.) |
| setUnicastAddress |
Set the unicastAddress to be used by
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 ucastAddress and mcastAddress
parameters you will need to call createConnection. If that is not your use case, then just call
createConnection(DOF, DOFAddress, DOFAddress)
.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also