Package org.apache.activemq.artemis.api.core.management

Interface DivertControl

public interface DivertControl
A DivertControl is used to manage a divert.

  • Method Details

    • getFilter

      String getFilter()
      Returns the filter used by this divert.
      Returns:
      the filter used by this divert

    • isExclusive

      boolean isExclusive()
      Returns true if messages will be exclusively diverted and will not be routed to the origin address; otherwise false if messages will be routed both to the origin address and the forwarding address.
      Returns:
      true if messages will be exclusively diverted and will not be routed to the origin address; otherwise false if messages will be routed both to the origin address and the forwarding address

    • getUniqueName

      String getUniqueName()
      Returns the cluster-wide unique name of this divert.
      Returns:
      the cluster-wide unique name of this divert

    • getRoutingName

      String getRoutingName()
      Returns the routing name of this divert.
      Returns:
      the routing name of this divert

    • getAddress

      String getAddress()
      Returns the origin address used by this divert.
      Returns:
      the origin address used by this divert

    • getForwardingAddress

      String getForwardingAddress()
      Returns the forwarding address used by this divert.
      Returns:
      the forwarding address used by this divert

    • getTransformerClassName

      String getTransformerClassName()
      Returns the name of the org.apache.activemq.artemis.core.server.transformer.Transformer implementation associated with this divert.
      Returns:
      the name of the org.apache.activemq.artemis.core.server.transformer.Transformer implementation associated with this divert

    • getTransformerPropertiesAsJSON

      String getTransformerPropertiesAsJSON()
      Returns a map of key/value pairs used to configure the transformer in JSON form.
      Returns:
      a map of key/value pairs used to configure the transformer in JSON form

    • getTransformerProperties

      Map<String,String> getTransformerProperties() throws Exception
      Returns a map of the key/value pairs used to configure the transformer.
      Returns:
      a map of the key/value pairs used to configure the transformer
      Throws:
      Exception

    • getRoutingType

      String getRoutingType()
      Returns the routing type used by this divert.
      Returns:
      the routing type used by this divert

    • isRetroactiveResource

      boolean isRetroactiveResource()