org.wildfly.extras.creaper.commands.socketbindings

Class AddSocketBinding.Builder

java.lang.Object

org.wildfly.extras.creaper.commands.socketbindings.AddSocketBinding.Builder

Enclosing class:

AddSocketBinding

public static final class AddSocketBinding.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(String socketBindingName) When socket binding group is not selected, default will be set.
Builder(String socketBindingName, String socketBindingGroup)

Method Summary

Modifier and Type	Method and Description
AddSocketBinding	build()
AddSocketBinding.Builder	clientMappings(String... clientMappingsToAdd) Specifies zero or more client mappings for this socket binding.
AddSocketBinding.Builder	fixedPort(boolean isPortFixed) Whether the port value should remain fixed even if numeric offsets are applied to the other sockets in the socket group.
AddSocketBinding.Builder	interfaceName(String interfaceName) Name of the interface to which the socket should be bound, or, for multicast sockets, the interface on which it should listen.
AddSocketBinding.Builder	multicastAddress(String multicastAddress) Multicast address on which the socket should receive multicast traffic.
AddSocketBinding.Builder	multicastPort(Integer multicastPort) Port on which the socket should receive multicast traffic.
AddSocketBinding.Builder	port(Integer port) Number of the port to which the socket should be bound.
AddSocketBinding.Builder	replaceExisting(boolean replaceExisting) Specify whether to replace the existing socket binding based on its name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String socketBindingName)

When socket binding group is not selected, default will be set. Default group for standalone mode is standard-sockets and default group for domain mode is full-sockets. full-sockets is default socket group only for all started servers in default server configuration (server-one and server-two).

Builder

public Builder(String socketBindingName,
               String socketBindingGroup)

Method Detail

clientMappings

public AddSocketBinding.Builder clientMappings(String... clientMappingsToAdd)

Specifies zero or more client mappings for this socket binding. A client connecting to this socket should use the destination address specified in the mapping that matches its desired outbound interface. This allows for advanced network topologies that use either network address translation, or have bindings on multiple network interfaces to function. Each mapping should be evaluated in declared order, with the first successful match used to determine the destination.

fixedPort

public AddSocketBinding.Builder fixedPort(boolean isPortFixed)

Whether the port value should remain fixed even if numeric offsets are applied to the other sockets in the socket group.

interfaceName

public AddSocketBinding.Builder interfaceName(String interfaceName)

Name of the interface to which the socket should be bound, or, for multicast sockets, the interface on which it should listen. This should be one of the declared interfaces.

multicastAddress

public AddSocketBinding.Builder multicastAddress(String multicastAddress)

Multicast address on which the socket should receive multicast traffic. If unspecified, the socket will not be configured to receive multicast.

multicastPort

public AddSocketBinding.Builder multicastPort(Integer multicastPort)

Port on which the socket should receive multicast traffic. Must be configured if 'multicast-address' is configured.

port

public AddSocketBinding.Builder port(Integer port)

Number of the port to which the socket should be bound.

replaceExisting

public AddSocketBinding.Builder replaceExisting(boolean replaceExisting)

Specify whether to replace the existing socket binding based on its name.

build

public AddSocketBinding build()