WildFly Full 26.1 Model Reference

  1. home
  2. socket-binding-group
  3. socket-binding

Configuration information for a socket.

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.network.socket-binding true

none

Attributes (10)

  • bound Whether an actual socket using this socket binding configuration has been bound.
    • Attribute Value
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • bound-address The address to which the actual socket using this socket binding configuration has been bound, or undefined if no socket has been bound.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • bound-port The port to which the actual socket using this socket binding configuration has been bound, or undefined if no socket has been bound.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed false
    Min 1
    Max 2,147,483,647
    Storage runtime
    Access Type read-only
  • client-mappings 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.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • fixed-port Whether the port value should remain fixed even if numeric offsets are applied to the other sockets in the socket group.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • interface 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.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • multicast-address Multicast address on which the socket should receive multicast traffic. If unspecified, the socket will not be configured to receive multicast.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • multicast-port Port on which the socket should receive multicast traffic. Must be configured if 'multicast-address' is configured.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Min 1
    Max 65,535
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • name The name of the socket. Services which need to access the socket configuration information will find it using this name.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • port Number of the port to which the socket should be bound.
    • Attribute Value
    Default Value 0
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 65,535
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (2)

  • add Adds a socket binding configuration to the group.
    Request Parameter Type Required Expressions Allowed Default value Description
    client-mappings LIST false false 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.
    fixed-port BOOLEAN false true false Whether the port value should remain fixed even if numeric offsets are applied to the other sockets in the socket group.
    interface STRING false true 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.
    multicast-address STRING false true Multicast address on which the socket should receive multicast traffic. If unspecified, the socket will not be configured to receive multicast.
    multicast-port INT false true Port on which the socket should receive multicast traffic. Must be configured if 'multicast-address' is configured.
    port INT false true 0 Number of the port to which the socket should be bound.
  • remove Removes a socket binding configuration from the group.