Class ProtonProtocolManager

java.lang.Object

org.apache.activemq.artemis.spi.core.protocol.AbstractProtocolManager<AMQPMessage, AmqpInterceptor, ActiveMQProtonRemotingConnection, AMQPRoutingHandler>

org.apache.activemq.artemis.protocol.amqp.broker.ProtonProtocolManager

All Implemented Interfaces:

org.apache.activemq.artemis.core.server.management.NotificationListener, ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

Direct Known Subclasses:

ProtonClientProtocolManager

public class ProtonProtocolManager
extends AbstractProtocolManager<AMQPMessage, AmqpInterceptor, ActiveMQProtonRemotingConnection, AMQPRoutingHandler>
implements org.apache.activemq.artemis.core.server.management.NotificationListener

A proton protocol manager, basically reads the Proton Input and maps proton resources to ActiveMQ Artemis resources

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MIRROR_ADDRESS

Constructor Summary

Constructors

Constructor	Description
ProtonProtocolManager(ProtonProtocolManagerFactory factory, org.apache.activemq.artemis.core.server.ActiveMQServer server, List<BaseInterceptor> incomingInterceptors, List<BaseInterceptor> outgoingInterceptors)

Method Summary

Modifier and Type	Method	Description
boolean	acceptsNoHandshake()
void	addChannelHandlers(io.netty.channel.ChannelPipeline pipeline)
ProtonClientProtocolManager	createClientManager()	for outgoing
ConnectionEntry	createConnectionEntry(Acceptor acceptorUsed, Connection remotingConnection)
ConnectionEntry	createOutgoingConnectionEntry(Connection remotingConnection)	This method is not part of the ProtocolManager interface because it only makes sense on AMQP.
ConnectionEntry	createOutgoingConnectionEntry(Connection remotingConnection, ClientSASLFactory saslFactory)
ConnectionEntry	createOutgoingConnectionEntry(Connection remotingConnection, ClientSASLFactory saslFactory, Map<org.apache.qpid.proton.amqp.Symbol, Object> connectionProperties)
ConnectionEntry	createOutgoingConnectionEntry(Connection remotingConnection, ClientSASLFactory saslFactory, Map<org.apache.qpid.proton.amqp.Symbol, Object> connectionProperties, org.apache.qpid.proton.amqp.Symbol[] offeredCapabilities, org.apache.qpid.proton.amqp.Symbol[] desiredCapabilities)
long	getAckManagerFlushTimeout()	Before the ackManager retries acks, it must flush the OperationContext on the MirrorTargets.
int	getAmqpCredits()
Long	getAmqpIdleTimeout()
int	getAmqpLowCredits()
int	getAmqpMinLargeMessageSize()
ProtocolManagerFactory<AmqpInterceptor>	getFactory()
int	getInitialRemoteMaxFrameSize()
int	getLinkQuiesceTimeout()	Returns the time in milliseconds to wait for remote sender once a link quiesce is initiated by this peer.
int	getMaxFrameSize()
static String	getMirrorAddress(String connectionName)
int	getMirrorMaxPendingAcks()
Map<SimpleString, RoutingType>	getPrefixes()
String	getPubSubPrefix()
ReferenceIDSupplier	getReferenceIDSupplier()
AMQPRoutingHandler	getRoutingHandler()
String	getSaslLoginConfigScope()
String[]	getSaslMechanisms()
org.apache.activemq.artemis.core.server.ActiveMQServer	getServer()
void	handleBuffer(RemotingConnection connection, ActiveMQBuffer buffer)
void	handshake(org.apache.activemq.artemis.core.remoting.impl.netty.NettyServerConnection connection, ActiveMQBuffer buffer)
String	invokeIncoming(Message message, ActiveMQProtonRemotingConnection connection)
String	invokeOutgoing(Message message, ActiveMQProtonRemotingConnection connection)
boolean	isAmqpDuplicateDetection()
boolean	isAmqpTreatRejectAsUnmodifiedDeliveryFailed()
boolean	isDirectDeliver()
boolean	isDrainOnTransientDeliveryErrors()	Returns true if transient delivery errors should be handled by draining link credit from the remote sender.
boolean	isProtocol(byte[] array)
boolean	isUseModifiedForTransientDeliveryErrors()	Returns true if transient delivery errors should be handled with a Modified disposition (if permitted by link).
void	onNotification(org.apache.activemq.artemis.core.server.management.Notification notification)
ProtonProtocolManager	setAckManagerFlushTimeout(long ackManagerFlushTimeout)
ProtonProtocolManager	setAmqpCredits(int amqpCredits)
ProtonProtocolManager	setAmqpDrainOnTransientDeliveryErrors(boolean amqpDrainOnTransientDeliveryErrors)	Sets if transient delivery errors should be handled by draining link credit from the remote sender
ProtonProtocolManager	setAmqpDuplicateDetection(boolean duplicateDetection)
ProtonProtocolManager	setAmqpIdleTimeout(Long ttl)
ProtonProtocolManager	setAmqpLinkQuiesceTimeout(int amqpLinkQuiesceTimeout)	Sets the time in milliseconds to wait before closing a remote sender link if the server has requested that the link drain all outstanding credit an complete pending settlements.
ProtonProtocolManager	setAmqpLowCredits(int amqpLowCredits)
ProtonProtocolManager	setAmqpMinLargeMessageSize(int amqpMinLargeMessageSize)
void	setAmqpTreatRejectAsUnmodifiedDeliveryFailed(boolean amqpTreatRejectAsUnmodifiedDeliveryFailed)
ProtonProtocolManager	setAmqpUseModifiedForTransientDeliveryErrors(boolean amqpUseModifiedForTransientDeliveryErrors)	Sets if transient delivery errors should be handled with a Modified disposition (if permitted by link)
void	setAnycastPrefix(String anycastPrefix)
ProtonProtocolManager	setDirectDeliver(boolean directDeliver)
void	setInitialRemoteMaxFrameSize(int initialRemoteMaxFrameSize)
void	setMaxFrameSize(int maxFrameSize)
ProtonProtocolManager	setMirrorMaxPendingAcks(int maxPendingAcks)
void	setMulticastPrefix(String multicastPrefix)
void	setPubSubPrefix(String pubSubPrefix)
void	setSaslLoginConfigScope(String saslLoginConfigScope)
void	setSaslMechanisms(String[] saslMechanisms)
void	updateInterceptors(List incoming, List outgoing)
List<String>	websocketSubprotocolIdentifiers()

Methods inherited from class AbstractProtocolManager

getSecurityDomain, invokeInterceptors, setSecurityDomain

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ProtocolManager

removeHandler

Field Details

MIRROR_ADDRESS

public static final String MIRROR_ADDRESS

See Also:

• Constant Field Values

Constructor Details

ProtonProtocolManager

public ProtonProtocolManager(ProtonProtocolManagerFactory factory,
 org.apache.activemq.artemis.core.server.ActiveMQServer server,
 List<BaseInterceptor> incomingInterceptors,
 List<BaseInterceptor> outgoingInterceptors)

Method Details

getMirrorAddress

public static String getMirrorAddress(String connectionName)

getReferenceIDSupplier

public ReferenceIDSupplier getReferenceIDSupplier()

getServer

public org.apache.activemq.artemis.core.server.ActiveMQServer getServer()

onNotification

public void onNotification(org.apache.activemq.artemis.core.server.management.Notification notification)

Specified by:

onNotification in interface org.apache.activemq.artemis.core.server.management.NotificationListener

getAckManagerFlushTimeout

public long getAckManagerFlushTimeout()

Before the ackManager retries acks, it must flush the OperationContext on the MirrorTargets. This is the timeout is in milliseconds

setAckManagerFlushTimeout

public ProtonProtocolManager setAckManagerFlushTimeout(long ackManagerFlushTimeout)

getAmqpMinLargeMessageSize

public int getAmqpMinLargeMessageSize()

getMirrorMaxPendingAcks

public int getMirrorMaxPendingAcks()

setMirrorMaxPendingAcks

public ProtonProtocolManager setMirrorMaxPendingAcks(int maxPendingAcks)

setAmqpMinLargeMessageSize

public ProtonProtocolManager setAmqpMinLargeMessageSize(int amqpMinLargeMessageSize)

isAmqpDuplicateDetection

public boolean isAmqpDuplicateDetection()

setAmqpDuplicateDetection

public ProtonProtocolManager setAmqpDuplicateDetection(boolean duplicateDetection)

getFactory

public ProtocolManagerFactory<AmqpInterceptor> getFactory()

Specified by:

getFactory in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

updateInterceptors

public void updateInterceptors(List incoming,
 List outgoing)

Specified by:

updateInterceptors in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

acceptsNoHandshake

public boolean acceptsNoHandshake()

Specified by:

acceptsNoHandshake in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

getAmqpIdleTimeout

public Long getAmqpIdleTimeout()

setAmqpIdleTimeout

public ProtonProtocolManager setAmqpIdleTimeout(Long ttl)

isDirectDeliver

public boolean isDirectDeliver()

setDirectDeliver

public ProtonProtocolManager setDirectDeliver(boolean directDeliver)

createClientManager

public ProtonClientProtocolManager createClientManager()

for outgoing

createConnectionEntry

public ConnectionEntry createConnectionEntry(Acceptor acceptorUsed,
 Connection remotingConnection)

Specified by:

createConnectionEntry in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

createOutgoingConnectionEntry

public ConnectionEntry createOutgoingConnectionEntry(Connection remotingConnection)

This method is not part of the ProtocolManager interface because it only makes sense on AMQP. More specifically on AMQP Bridges

createOutgoingConnectionEntry

public ConnectionEntry createOutgoingConnectionEntry(Connection remotingConnection,
 ClientSASLFactory saslFactory)

createOutgoingConnectionEntry

public ConnectionEntry createOutgoingConnectionEntry(Connection remotingConnection,
 ClientSASLFactory saslFactory,
 Map<org.apache.qpid.proton.amqp.Symbol, Object> connectionProperties)

createOutgoingConnectionEntry

public ConnectionEntry createOutgoingConnectionEntry(Connection remotingConnection,
 ClientSASLFactory saslFactory,
 Map<org.apache.qpid.proton.amqp.Symbol, Object> connectionProperties,
 org.apache.qpid.proton.amqp.Symbol[] offeredCapabilities,
 org.apache.qpid.proton.amqp.Symbol[] desiredCapabilities)

handleBuffer

public void handleBuffer(RemotingConnection connection,
 ActiveMQBuffer buffer)

Specified by:

handleBuffer in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

addChannelHandlers

public void addChannelHandlers(io.netty.channel.ChannelPipeline pipeline)

Specified by:

addChannelHandlers in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

getAmqpCredits

public int getAmqpCredits()

setAmqpCredits

public ProtonProtocolManager setAmqpCredits(int amqpCredits)

getAmqpLowCredits

public int getAmqpLowCredits()

setAmqpLowCredits

public ProtonProtocolManager setAmqpLowCredits(int amqpLowCredits)

isProtocol

public boolean isProtocol(byte[] array)

Specified by:

isProtocol in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

handshake

public void handshake(org.apache.activemq.artemis.core.remoting.impl.netty.NettyServerConnection connection,
 ActiveMQBuffer buffer)

Specified by:

handshake in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

websocketSubprotocolIdentifiers

public List<String> websocketSubprotocolIdentifiers()

Specified by:

websocketSubprotocolIdentifiers in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

getPubSubPrefix

public String getPubSubPrefix()

setPubSubPrefix

public void setPubSubPrefix(String pubSubPrefix)

getMaxFrameSize

public int getMaxFrameSize()

setMaxFrameSize

public void setMaxFrameSize(int maxFrameSize)

getSaslMechanisms

public String[] getSaslMechanisms()

setSaslMechanisms

public void setSaslMechanisms(String[] saslMechanisms)

getSaslLoginConfigScope

public String getSaslLoginConfigScope()

setSaslLoginConfigScope

public void setSaslLoginConfigScope(String saslLoginConfigScope)

setAnycastPrefix

public void setAnycastPrefix(String anycastPrefix)

Specified by:

setAnycastPrefix in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

Overrides:

setAnycastPrefix in class AbstractProtocolManager<AMQPMessage, AmqpInterceptor, ActiveMQProtonRemotingConnection, AMQPRoutingHandler>

setMulticastPrefix

public void setMulticastPrefix(String multicastPrefix)

Specified by:

setMulticastPrefix in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

Overrides:

setMulticastPrefix in class AbstractProtocolManager<AMQPMessage, AmqpInterceptor, ActiveMQProtonRemotingConnection, AMQPRoutingHandler>

getPrefixes

public Map<SimpleString, RoutingType> getPrefixes()

Specified by:

getPrefixes in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

Overrides:

getPrefixes in class AbstractProtocolManager<AMQPMessage, AmqpInterceptor, ActiveMQProtonRemotingConnection, AMQPRoutingHandler>

getRoutingHandler

public AMQPRoutingHandler getRoutingHandler()

Specified by:

getRoutingHandler in interface ProtocolManager<AmqpInterceptor, AMQPRoutingHandler>

invokeIncoming

public String invokeIncoming(Message message,
 ActiveMQProtonRemotingConnection connection)

invokeOutgoing

public String invokeOutgoing(Message message,
 ActiveMQProtonRemotingConnection connection)

getInitialRemoteMaxFrameSize

public int getInitialRemoteMaxFrameSize()

setInitialRemoteMaxFrameSize

public void setInitialRemoteMaxFrameSize(int initialRemoteMaxFrameSize)

isUseModifiedForTransientDeliveryErrors

public boolean isUseModifiedForTransientDeliveryErrors()

Returns true if transient delivery errors should be handled with a Modified disposition (if permitted by link).

Returns:

true if transient delivery errors should be handled with a Modified disposition (if permitted by link)

setAmqpUseModifiedForTransientDeliveryErrors

public ProtonProtocolManager setAmqpUseModifiedForTransientDeliveryErrors(boolean amqpUseModifiedForTransientDeliveryErrors)

Sets if transient delivery errors should be handled with a Modified disposition (if permitted by link)

setAmqpTreatRejectAsUnmodifiedDeliveryFailed

public void setAmqpTreatRejectAsUnmodifiedDeliveryFailed(boolean amqpTreatRejectAsUnmodifiedDeliveryFailed)

isAmqpTreatRejectAsUnmodifiedDeliveryFailed

public boolean isAmqpTreatRejectAsUnmodifiedDeliveryFailed()

isDrainOnTransientDeliveryErrors

public boolean isDrainOnTransientDeliveryErrors()

Returns true if transient delivery errors should be handled by draining link credit from the remote sender.

Returns:

true if transient delivery errors should be handled by draining link credit from the remote sender

setAmqpDrainOnTransientDeliveryErrors

public ProtonProtocolManager setAmqpDrainOnTransientDeliveryErrors(boolean amqpDrainOnTransientDeliveryErrors)

Sets if transient delivery errors should be handled by draining link credit from the remote sender

Parameters:

amqpDrainOnTransientDeliveryErrors - Set to true if senders should be drained on transient delivery errors.

Returns:

this protocol manager instance.

getLinkQuiesceTimeout

public int getLinkQuiesceTimeout()

Returns the time in milliseconds to wait for remote sender once a link quiesce is initiated by this peer.

Returns:

the time in milliseconds to wait for remote sender once a link quiesce is initiated by this peer

setAmqpLinkQuiesceTimeout

public ProtonProtocolManager setAmqpLinkQuiesceTimeout(int amqpLinkQuiesceTimeout)

Sets the time in milliseconds to wait before closing a remote sender link if the server has requested that the link drain all outstanding credit an complete pending settlements. A value less than or equal to zero disables drain timeouts.

Parameters:

amqpLinkQuiesceTimeout - The time in milliseconds to wait for quiesce to complete.

Returns:

this protocol manager instance.