Package org.wildfly.extension.messaging.activemq

Interface ActiveMQBroker

All Known Implementing Classes:
ActiveMQBrokerImpl
public interface ActiveMQBroker
Wrapper interface to expose methods from ActiveMQServer and ManagementService that are needed by a /subsystem=messaging-activemq/server=* resource or its children."
Author:
Emmanuel Hugonnet (c) 2023 Red Hat, Inc.

  • Method Details

    • getDelegate

      Object getDelegate()
      To get an untyped access to ActiveMQServer.
      Returns:
      the underlying ActiveMQServer

    • getNodeID

      SimpleString getNodeID()
      Returns:
      the server node id.

    • addConnectorConfiguration

      void addConnectorConfiguration(String string, TransportConfiguration tc)
      Add a connection configuration to the current ActiveMQServer.
      Parameters:
      string - : the name of the connector.
      tc - : the trnasport configurartion.

    • createQueue

      void createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary) throws Exception
      Creates a Queue on the underlying ActiveMQServer.
      Parameters:
      address - : the queue address.
      routingType - : the queue routing type (anycast or mulicast).
      queueName - : the name of the queue.
      filter - : the filter.
      durable -
      temporary -
      Throws:
      Exception

    • destroyQueue

      void destroyQueue(SimpleString queueName, SecurityAuth session, boolean checkConsumerCount) throws Exception
      Destroys a queue from the underlying ActiveMQServer.
      Parameters:
      queueName -
      session -
      checkConsumerCount -
      Throws:
      Exception

    • isActive

      boolean isActive()
      Returns the current state of the server: true - if the server is started and active - false otherwise.
      Returns:
      the current state of the server: true - if the server is started and active - false otherwise.

    • hasResource

      boolean hasResource(String resourceName)
      Returns true if the resource exists - false otherwise.
      Parameters:
      resourceName - : the name of the reosurce.
      Returns:
      true if the resource exists - false otherwise.

    • getResource

      Object getResource(String resourceName)
      Returns the untyped resource with the specified name- null if none exists.
      Parameters:
      resourceName - : the name of the resource.
      Returns:
      the untyped resource with the specified name- null if none exists.

    • getResources

      Object[] getResources(Class<?> resourceType)
      Returns an untyped array of the resources of this type - an empty arry if none exists.
      Parameters:
      resourceType - : the type of resources.
      Returns:
      an untyped array of the resources of this type - an empty arry if none exists.

    • getActiveMQServerControl

      ActiveMQServerControl getActiveMQServerControl()
      Returns the ActiveMQServerControl to manage the underlying ActiveMQServer.
      Returns:
      the ActiveMQServerControl

    • getAddressSettingsAsJSON

      String getAddressSettingsAsJSON(String addressMatch)
      Returns the JSON description of the address settings of the specified match address.
      Parameters:
      addressMatch - the address settings match address.
      Returns:
      the JSON description of the address settings of the specified match address