Package org.apache.activemq.artemis.spi.core.protocol

Interface ProtocolManagerFactory<P extends BaseInterceptor>

All Known Implementing Classes:

AbstractProtocolManagerFactory, CoreProtocolManagerFactory

public interface ProtocolManagerFactory<P extends BaseInterceptor>

Method Summary

Modifier and Type	Method	Description
ProtocolManager	createProtocolManager(ActiveMQServer server, Map<String,Object> parameters, List<BaseInterceptor> incomingInterceptors, List<BaseInterceptor> outgoingInterceptors)	When you create the ProtocolManager, you should filter out any interceptors that won't belong to this Protocol.
List<P>	filterInterceptors(List<BaseInterceptor> interceptors)	This should get the entire list and only return the ones this factory can deal with
String	getModuleName()
default Persister<Message>[]	getPersister()
String[]	getProtocols()
void	loadProtocolServices(ActiveMQServer server, List<ActiveMQComponent> services)
void	updateProtocolServices(ActiveMQServer server, List<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 Persister<Message>[] getPersister()

createProtocolManager

ProtocolManager createProtocolManager(ActiveMQServer server,
 Map<String,Object> parameters,
 List<BaseInterceptor> incomingInterceptors,
 List<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<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(ActiveMQServer server,
 List<ActiveMQComponent> services)

updateProtocolServices

void updateProtocolServices(ActiveMQServer server,
 List<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.