Interface ProtocolManagerFactory<P extends org.apache.activemq.artemis.api.core.BaseInterceptor>

All Known Implementing Classes:
AbstractProtocolManagerFactory
public interface ProtocolManagerFactory<P extends org.apache.activemq.artemis.api.core.BaseInterceptor>

  • Method Summary

    Modifier and Type
    Method
    Description
    ProtocolManager
    createProtocolManager(org.apache.activemq.artemis.core.server.ActiveMQServer server, Map<String,Object> parameters, List<org.apache.activemq.artemis.api.core.BaseInterceptor> incomingInterceptors, List<org.apache.activemq.artemis.api.core.BaseInterceptor> outgoingInterceptors)
    When you create the ProtocolManager, you should filter out any interceptors that won't belong to this Protocol.
    List<P>
    filterInterceptors(List<org.apache.activemq.artemis.api.core.BaseInterceptor> interceptors)
    This should get the entire list and only return the ones this factory can deal with
    String
    getModuleName()
     
    default org.apache.activemq.artemis.core.persistence.Persister<org.apache.activemq.artemis.api.core.Message>[]
    getPersister()
     
    String[]
    getProtocols()
     
    void
    loadProtocolServices(org.apache.activemq.artemis.core.server.ActiveMQServer server, List<org.apache.activemq.artemis.core.server.ActiveMQComponent> services)
     
    void
    updateProtocolServices(org.apache.activemq.artemis.core.server.ActiveMQServer server, List<org.apache.activemq.artemis.core.server.ActiveMQComponent> services)
    Provides an entry point for the server to trigger the protocol manager factory to update its protocol services based on updates to server configuration.

  • Method Details

    • getPersister

      default org.apache.activemq.artemis.core.persistence.Persister<org.apache.activemq.artemis.api.core.Message>[] getPersister()

    • createProtocolManager

      ProtocolManager createProtocolManager(org.apache.activemq.artemis.core.server.ActiveMQServer server, Map<String,Object> parameters, List<org.apache.activemq.artemis.api.core.BaseInterceptor> incomingInterceptors, List<org.apache.activemq.artemis.api.core.BaseInterceptor> outgoingInterceptors) throws Exception
      When you create the ProtocolManager, you should filter out any interceptors that won't belong to this Protocol. For example don't send any core Interceptors Interceptor to Stomp * * *
      Throws:
      Exception

    • filterInterceptors

      List<P> filterInterceptors(List<org.apache.activemq.artemis.api.core.BaseInterceptor> interceptors)
      This should get the entire list and only return the ones this factory can deal with

    • getProtocols

      String[] getProtocols()

    • getModuleName

      String getModuleName()

    • loadProtocolServices

      void loadProtocolServices(org.apache.activemq.artemis.core.server.ActiveMQServer server, List<org.apache.activemq.artemis.core.server.ActiveMQComponent> services)

    • updateProtocolServices

      void updateProtocolServices(org.apache.activemq.artemis.core.server.ActiveMQServer server, List<org.apache.activemq.artemis.core.server.ActiveMQComponent> services) throws Exception
      Provides an entry point for the server to trigger the protocol manager factory to update its protocol services based on updates to server configuration.
      Parameters:
      server - The service instance that has triggered this update
      services - The protocol services that were previously registered (mutable).
      Throws:
      Exception - can throw an exception if an error occurs while updating or adding protocol services from configuration updates.