Class AmqpSenderOptions

java.lang.Object
io.vertx.amqp.AmqpSenderOptions
public class AmqpSenderOptions extends Object
Configures the AMQP Sender.

  • Constructor Details

    • AmqpSenderOptions

      public AmqpSenderOptions()

    • AmqpSenderOptions

      public AmqpSenderOptions(AmqpSenderOptions other)

    • AmqpSenderOptions

      public AmqpSenderOptions(JsonObject json)

  • Method Details

    • toJson

      public JsonObject toJson()

    • getLinkName

      public String getLinkName()

    • setLinkName

      public AmqpSenderOptions setLinkName(String linkName)

    • isDynamic

      public boolean isDynamic()
      Returns:
      whether the sender is using a dynamic address.

    • setDynamic

      public AmqpSenderOptions setDynamic(boolean dynamic)
      Sets whether the Target terminus to be used should specify it is 'dynamic', requesting the peer creates a node and names it with a generated address.

      The address provided by the peer can then be inspected using the AmqpSender.address() method on the AmqpSender received once opened.

      Parameters:
      dynamic - true if the sender should request dynamic creation of a node and address to send to
      Returns:
      the options

    • isAutoDrained

      public boolean isAutoDrained()
      Get whether the link will automatically be marked drained after the send queue drain handler fires in drain mode.
      Returns:
      whether the link will automatically be drained after the send queue drain handler fires in drain mode
      See Also:

    • setAutoDrained

      public AmqpSenderOptions setAutoDrained(boolean autoDrained)
      Sets whether the link is automatically marked drained after the send queue drain handler callback returns if the receiving peer requested that credit be drained.

      true by default.

      Parameters:
      autoDrained - whether the link will automatically be drained after the send queue drain handler fires in drain mode
      Returns:
      the options

    • getCapabilities

      public List<String> getCapabilities()
      Gets the list of capabilities to be set on the sender target terminus.
      Returns:
      the list of capabilities, empty if none.

    • setCapabilities

      public AmqpSenderOptions setCapabilities(List<String> capabilities)
      Sets the list of capabilities to be set on the sender target terminus.
      Parameters:
      capabilities - the set of target capabilities.
      Returns:
      the options

    • addCapability

      public AmqpSenderOptions addCapability(String capability)
      Adds a capability to be set on the sender target terminus.
      Parameters:
      capability - the target capability to add, must not be null
      Returns:
      the options

    • getLinkProperties

      public Map<String,Object> getLinkProperties()
      Gets the link properties to be sent in the AMQP attach frame.
      Returns:
      the link properties map, or null if not set.

    • setLinkProperties

      public AmqpSenderOptions setLinkProperties(Map<String,Object> linkProperties)
      Sets link properties to be sent in the AMQP attach frame. Keys are converted to AMQP Symbol type when applied.
      Parameters:
      linkProperties - the link properties map
      Returns:
      the options

    • getSourceOptions

      public SourceOptions getSourceOptions()
      Gets the source terminus options.
      Returns:
      the source options, or null if not set.

    • setSourceOptions

      public AmqpSenderOptions setSourceOptions(SourceOptions sourceOptions)
      Sets the source terminus options for fine-grained control over the sender's source terminus.
      Parameters:
      sourceOptions - the source terminus options
      Returns:
      the options

    • getTargetOptions

      public TargetOptions getTargetOptions()
      Gets the target terminus options.
      Returns:
      the target options, or null if not set.

    • setTargetOptions

      public AmqpSenderOptions setTargetOptions(TargetOptions targetOptions)
      Sets the target terminus options for fine-grained control over durability, expiry policy, timeout, and capabilities.

      If TargetOptions.getCapabilities() is set, it overrides the capabilities set via setCapabilities(List) and addCapability(String).

      If TargetOptions.getAddress() is set, it overrides the address passed to AmqpConnection.createSender(String, AmqpSenderOptions). It may also conflict with the setDynamic(boolean) option, which requests the peer to generate the target address.

      Parameters:
      targetOptions - the target terminus options
      Returns:
      the options