Interface ProtocolManager<P extends BaseInterceptor,R extends org.apache.activemq.artemis.core.server.routing.RoutingHandler>
- All Known Implementing Classes:
AbstractProtocolManager
public interface ProtocolManager<P extends BaseInterceptor,R extends org.apache.activemq.artemis.core.server.routing.RoutingHandler>
Info: ProtocolManager is loaded by
RemotingServiceImpl.loadProtocolManagerFactories(Iterable)-
Method Summary
Modifier and TypeMethodDescriptionbooleanIf this protocols accepts connectoins without an initial handshake.voidaddChannelHandlers(io.netty.channel.ChannelPipeline pipeline) createConnectionEntry(Acceptor acceptorUsed, Connection connection) voidhandleBuffer(RemotingConnection connection, ActiveMQBuffer buffer) voidhandshake(org.apache.activemq.artemis.core.remoting.impl.netty.NettyServerConnection connection, ActiveMQBuffer buffer) booleanisProtocol(byte[] array) default voidremoveHandler(String name) voidsetAnycastPrefix(String anycastPrefix) voidsetMulticastPrefix(String multicastPrefix) voidsetSecurityDomain(String securityDomain) voidupdateInterceptors(List<BaseInterceptor> incomingInterceptors, List<BaseInterceptor> outgoingInterceptors) This method will receive all the interceptors on the system and you should filter them outA list of the IANA websocket subprotocol identifiers (https://www.iana.org/assignments/websocket/websocket.xhtml) supported by this protocol manager.
-
Method Details
-
getFactory
ProtocolManagerFactory<P> getFactory() -
updateInterceptors
void updateInterceptors(List<BaseInterceptor> incomingInterceptors, List<BaseInterceptor> outgoingInterceptors) This method will receive all the interceptors on the system and you should filter them out -
createConnectionEntry
-
removeHandler
-
handleBuffer
-
addChannelHandlers
void addChannelHandlers(io.netty.channel.ChannelPipeline pipeline) -
isProtocol
boolean isProtocol(byte[] array) -
acceptsNoHandshake
boolean acceptsNoHandshake()If this protocols accepts connectoins without an initial handshake. If true this protocol will be the failback case no other connections are made. New designed protocols should always require a handshake. This is only useful for legacy protocols. -
handshake
void handshake(org.apache.activemq.artemis.core.remoting.impl.netty.NettyServerConnection connection, ActiveMQBuffer buffer) -
websocketSubprotocolIdentifiers
A list of the IANA websocket subprotocol identifiers (https://www.iana.org/assignments/websocket/websocket.xhtml) supported by this protocol manager. These are used during the websocket subprotocol handshake.- Returns:
- A list of subprotocol ids
-
setAnycastPrefix
-
setMulticastPrefix
-
getPrefixes
Map<SimpleString,RoutingType> getPrefixes() -
setSecurityDomain
-
getSecurityDomain
String getSecurityDomain() -
getRoutingHandler
R getRoutingHandler()
-