org.apache.activemq.artemis.core.server.cluster.impl

Class BridgeImpl

java.lang.Object

org.apache.activemq.artemis.core.server.cluster.impl.BridgeImpl

All Implemented Interfaces:

SendAcknowledgementHandler, SessionFailureListener, ClientProducerFlowCallback, PriorityAware, FailureListener, ActiveMQComponent, Bridge, Consumer, ReadyListener

Direct Known Subclasses:

ClusterConnectionBridge

public class BridgeImpl
extends Object
implements Bridge, SessionFailureListener, SendAcknowledgementHandler, ReadyListener, ClientProducerFlowCallback

A Core BridgeImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	disconnectedAndDown
protected Executor	executor
protected ScheduledFuture<?>	futureScheduledReconnection Used when there's a scheduled reconnection
protected Queue	queue
protected ScheduledExecutorService	scheduledExecutor
protected ServerLocatorInternal	serverLocator
protected ClientSessionInternal	session
protected ClientSessionInternal	sessionConsumer
protected TopologyMember	targetNode
protected String	targetNodeID

Constructor Summary

Constructors

Constructor and Description

BridgeImpl(ServerLocatorInternal serverLocator, int initialConnectAttempts, int reconnectAttempts, int reconnectAttemptsSameNode, long retryInterval, double retryMultiplier, long maxRetryInterval, UUID nodeUUID, SimpleString name, Queue queue, Executor executor, Filter filter, SimpleString forwardingAddress, ScheduledExecutorService scheduledExecutor, Transformer transformer, boolean useDuplicateDetection, String user, String password, ActiveMQServer server, ComponentConfigurationRoutingType routingType)

Method Summary

Modifier and Type	Method and Description
void	activate()
protected void	afterConnect()
protected Message	beforeForward(Message message, SimpleString forwardingAddress)
protected Message	beforeForwardingNoCopy(Message message, SimpleString forwardingAddress) ClusterConnectionBridge already makes a copy of the message.
void	beforeReconnect(ActiveMQException exception) Notifies that a connection has failed due to the specified exception.
protected void	connect()
void	connectionFailed(ActiveMQException me, boolean failedOver) Notifies that a connection has failed due to the specified exception.
void	connectionFailed(ActiveMQException me, boolean failedOver, String scaleDownTargetNodeID) Notifies that a connection has failed due to the specified exception.
protected ClientSessionFactoryInternal	createSessionFactory()
String	debug()
void	disconnect() To be called when the server sent a disconnect to the client.
protected void	fail(boolean permanently)
void	flushExecutor()
ClientSessionFactoryImpl	getCSF()
List<MessageReference>	getDeliveringMessages()
static byte[]	getDuplicateBytes(UUID nodeUUID, long messageID)
Executor	getExecutor() The cluster manager needs to use the same executor to close the serverLocator, otherwise the stop will break.
Filter	getFilter()
SimpleString	getForwardingAddress()
RemotingConnection	getForwardingConnection()
BridgeMetrics	getMetrics()
SimpleString	getName()
Queue	getQueue()
ClientSessionFactory	getSessionFactory()
TopologyMember	getTargetNodeFromTopology() for use in tests mainly
Transformer	getTransformer()
HandleStatus	handle(MessageReference ref) There was a change on semantic during 2.3 here. We now first accept the message, and the actual deliver is done as part of Consumer.proceedDeliver(MessageReference).
boolean	isBlockedOnFlowControl() For tests mainly
boolean	isConnected()
boolean	isStarted()
protected void	nodeUP(TopologyMember member, boolean last)
void	onCreditsFail(ClientProducerCredits producerCredits)
void	onCreditsFlow(boolean blocked, ClientProducerCredits producerCredits)
void	pause()
void	proceedDeliver(MessageReference ref) This will proceed with the actual delivery.
void	readyForWriting()
protected ClientSessionFactoryInternal	reconnectOnOriginalNode()
void	resume()
protected void	scheduleRetryConnect()
protected void	scheduleRetryConnectFixedTimeout(long milliseconds)
void	sendAcknowledged(Message message) Notifies the client that a message sent asynchronously has been received by the server.
long	sequentialID() an unique sequential ID for this consumer
void	setNotificationService(NotificationService notificationService)
protected void	setSessionFactory(ClientSessionFactoryInternal sfi)
void	start()
void	stop()
String	toManagementString() This method will create a string representation meant for management operations.
String	toString()
protected void	tryScheduleRetryReconnect(ActiveMQExceptionType type)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.server.Consumer

errorProcessing, getPriority, promptDelivery, supportsDirectDelivery

Methods inherited from interface org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler

sendFailed

Field Detail

serverLocator

protected final ServerLocatorInternal serverLocator

executor

protected final Executor executor

scheduledExecutor

protected final ScheduledExecutorService scheduledExecutor

queue

protected final Queue queue

futureScheduledReconnection

protected ScheduledFuture<?> futureScheduledReconnection

Used when there's a scheduled reconnection

session

protected volatile ClientSessionInternal session

sessionConsumer

protected volatile ClientSessionInternal sessionConsumer

disconnectedAndDown

protected volatile boolean disconnectedAndDown

targetNodeID

protected String targetNodeID

targetNode

protected TopologyMember targetNode

Constructor Detail

BridgeImpl

public BridgeImpl(ServerLocatorInternal serverLocator,
                  int initialConnectAttempts,
                  int reconnectAttempts,
                  int reconnectAttemptsSameNode,
                  long retryInterval,
                  double retryMultiplier,
                  long maxRetryInterval,
                  UUID nodeUUID,
                  SimpleString name,
                  Queue queue,
                  Executor executor,
                  Filter filter,
                  SimpleString forwardingAddress,
                  ScheduledExecutorService scheduledExecutor,
                  Transformer transformer,
                  boolean useDuplicateDetection,
                  String user,
                  String password,
                  ActiveMQServer server,
                  ComponentConfigurationRoutingType routingType)

Method Detail

isBlockedOnFlowControl

public boolean isBlockedOnFlowControl()

For tests mainly

getDuplicateBytes

public static final byte[] getDuplicateBytes(UUID nodeUUID,
                                             long messageID)

getSessionFactory

public ClientSessionFactory getSessionFactory()

getDeliveringMessages

public List<MessageReference> getDeliveringMessages()

Specified by:

getDeliveringMessages in interface Consumer

Returns:

the list of messages being delivered

setNotificationService

public void setNotificationService(NotificationService notificationService)

Specified by:

setNotificationService in interface Bridge

onCreditsFlow

public void onCreditsFlow(boolean blocked,
                          ClientProducerCredits producerCredits)

Specified by:

onCreditsFlow in interface ClientProducerFlowCallback

onCreditsFail

public void onCreditsFail(ClientProducerCredits producerCredits)

Specified by:

onCreditsFail in interface ClientProducerFlowCallback

sequentialID

public long sequentialID()

Description copied from interface: Consumer

an unique sequential ID for this consumer

Specified by:

sequentialID in interface Consumer

start

public void start()
           throws Exception

Specified by:

start in interface ActiveMQComponent

Throws:

Exception

debug

public String debug()

Specified by:

debug in interface Consumer

flushExecutor

public void flushExecutor()

Specified by:

flushExecutor in interface Bridge

disconnect

public void disconnect()

Description copied from interface: Bridge

To be called when the server sent a disconnect to the client. Basically this is for cluster bridges being disconnected

Specified by:

disconnect in interface Bridge

Specified by:

disconnect in interface Consumer

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Bridge

getExecutor

public Executor getExecutor()

The cluster manager needs to use the same executor to close the serverLocator, otherwise the stop will break. This method is intended to expose this executor to the ClusterManager

stop

public void stop()
          throws Exception

Specified by:

stop in interface ActiveMQComponent

Throws:

Exception

pause

public void pause()
           throws Exception

Specified by:

pause in interface Bridge

Throws:

Exception

resume

public void resume()
            throws Exception

Specified by:

resume in interface Bridge

Throws:

Exception

isStarted

public boolean isStarted()

Specified by:

isStarted in interface ActiveMQComponent

activate

public void activate()

getName

public SimpleString getName()

Specified by:

getName in interface Bridge

getQueue

public Queue getQueue()

Specified by:

getQueue in interface Bridge

getFilter

public Filter getFilter()

Specified by:

getFilter in interface Consumer

getForwardingAddress

public SimpleString getForwardingAddress()

Specified by:

getForwardingAddress in interface Bridge

getForwardingConnection

public RemotingConnection getForwardingConnection()

Specified by:

getForwardingConnection in interface Bridge

sendAcknowledged

public void sendAcknowledged(Message message)

Description copied from interface: SendAcknowledgementHandler

Notifies the client that a message sent asynchronously has been received by the server.

Specified by:

sendAcknowledged in interface SendAcknowledgementHandler

Parameters:

message - message sent asynchronously

beforeForward

protected Message beforeForward(Message message,
                                SimpleString forwardingAddress)

beforeForwardingNoCopy

protected Message beforeForwardingNoCopy(Message message,
                                         SimpleString forwardingAddress)

ClusterConnectionBridge already makes a copy of the message. So I needed I hook where the message is not copied.

readyForWriting

public void readyForWriting()

Specified by:

readyForWriting in interface ReadyListener

handle

public HandleStatus handle(MessageReference ref)
                    throws Exception

Description copied from interface: Consumer

There was a change on semantic during 2.3 here.
We now first accept the message, and the actual deliver is done as part of Consumer.proceedDeliver(MessageReference). This is to avoid holding a lock on the queues while the delivery is being accomplished To avoid a lock on the queue in case of misbehaving consumers.

This should return busy if handle is called before proceed deliver is called

Specified by:

handle in interface Consumer

Returns:

Throws:

Exception

proceedDeliver

public void proceedDeliver(MessageReference ref)

Description copied from interface: Consumer

This will proceed with the actual delivery. Notice that handle should hold a readLock and proceedDelivery should release the readLock any lock operation on Consumer should also get a writeLock on the readWriteLock to guarantee there are no pending deliveries

Specified by:

proceedDeliver in interface Consumer

connectionFailed

public void connectionFailed(ActiveMQException me,
                             boolean failedOver)

Description copied from interface: FailureListener

Notifies that a connection has failed due to the specified exception.

Specified by:

connectionFailed in interface FailureListener

Parameters:

me - exception which has caused the connection to fail

connectionFailed

public void connectionFailed(ActiveMQException me,
                             boolean failedOver,
                             String scaleDownTargetNodeID)

Description copied from interface: FailureListener

Notifies that a connection has failed due to the specified exception.

Specified by:

connectionFailed in interface FailureListener

Parameters:

me - exception which has caused the connection to fail

scaleDownTargetNodeID - the ID of the node to which messages are scaling down

tryScheduleRetryReconnect

protected void tryScheduleRetryReconnect(ActiveMQExceptionType type)

beforeReconnect

public void beforeReconnect(ActiveMQException exception)

Description copied from interface: SessionFailureListener

Notifies that a connection has failed due to the specified exception.
This method is called before the session attempts to reconnect/failover.

Specified by:

beforeReconnect in interface SessionFailureListener

Parameters:

exception - exception which has caused the connection to fail

getTargetNodeFromTopology

public TopologyMember getTargetNodeFromTopology()

for use in tests mainly

Returns:

getMetrics

public BridgeMetrics getMetrics()

Specified by:

getMetrics in interface Bridge

toString

public String toString()

Overrides:

toString in class Object

toManagementString

public String toManagementString()

Description copied from interface: Consumer

This method will create a string representation meant for management operations. This is different from the toString method that's meant for debugging and will contain information that regular users won't understand well

Specified by:

toManagementString in interface Consumer

Returns:

getCSF

public ClientSessionFactoryImpl getCSF()

getTransformer

public Transformer getTransformer()

fail

protected void fail(boolean permanently)

afterConnect

protected void afterConnect()
                     throws Exception

Throws:

Exception

createSessionFactory

protected ClientSessionFactoryInternal createSessionFactory()
                                                     throws Exception

Throws:

Exception

reconnectOnOriginalNode

protected ClientSessionFactoryInternal reconnectOnOriginalNode()
                                                        throws Exception

Throws:

Exception

setSessionFactory

protected void setSessionFactory(ClientSessionFactoryInternal sfi)

connect

protected void connect()

scheduleRetryConnect

protected void scheduleRetryConnect()

nodeUP

protected void nodeUP(TopologyMember member,
                      boolean last)

scheduleRetryConnectFixedTimeout

protected void scheduleRetryConnectFixedTimeout(long milliseconds)