org.apache.activemq.artemis.core.protocol.stomp

Class StompConnection

java.lang.Object

org.apache.activemq.artemis.core.protocol.stomp.StompConnection

All Implemented Interfaces:

RemotingConnection, BufferHandler

public final class StompConnection
extends Object
implements RemotingConnection

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONNECTION_ID_PROP

Method Summary

Modifier and Type	Method and Description
void	abortTransaction(String txID)
void	acknowledge(String messageID, String subscriptionID)
void	addCloseListener(CloseListener listener) add a CloseListener.
void	addFailureListener(FailureListener listener) add a failure listener.
void	addStompEventListener(FrameEventListener listener)
void	autoCreateDestinationIfPossible(String queue)
protected void	beginTransaction(String txID)
void	bufferReceived(Object connectionID, ActiveMQBuffer buffer) called by the remoting connection when a buffer is received.
boolean	checkDataReceived() returns true if any data has been received since the last time this method was called.
void	checkDestination(String destination)
void	commitTransaction(String txID)
ServerMessageImpl	createServerMessage()
StompFrame	createStompMessage(ServerMessage serverMessage, StompSubscription subscription, int deliveryCount)
ActiveMQBuffer	createTransportBuffer(int size) creates a new ActiveMQBuffer of the specified size.
StompFrame	decode(ActiveMQBuffer buffer)
void	destroy() destroys this connection.
void	disconnect(boolean criticalError) Disconnect the connection, closing all channels
void	disconnect(String scaleDownNodeID, boolean criticalError) Disconnect the connection, closing all channels
boolean	enableMessageID()
void	fail(ActiveMQException me) called when the underlying connection fails.
void	fail(ActiveMQException me, String scaleDownTargetNodeID) called when the underlying connection fails.
void	flush() flush all outstanding data from the connection.
Acceptor	getAcceptorUsed()
String	getActiveMQServerName()
String	getClientID()
long	getCreationTime() Returns the creation time of the RemotingConnection.
List<FailureListener>	getFailureListeners() return all the failure listeners
VersionedStompFrameHandler	getFrameHandler()
Object	getID() Returns the unique id of the RemotingConnection.
String	getLogin()
StompProtocolManager	getManager()
int	getMinLargeMessageSize()
String	getPasscode()
String	getRemoteAddress() returns a string representation of the remote address of this connection
StompSession	getSession(String txID)
Connection	getTransportConnection() return the underlying Connection.
String	getVersion()
void	handleFrame(StompFrame request)
boolean	hasBytes()
boolean	isClient() Returns whether or not the RemotingConnection is a client
boolean	isDestroyed() Returns true if this RemotingConnection has been destroyed.
boolean	isSupportReconnect() This will check if reconnects are supported on the protocol and configuration.
boolean	isValid()
boolean	isWritable(ReadyListener callback)
void	killMessage(SimpleString nodeID) if slow consumer is killed,send the msessage to client.
void	negotiateVersion(StompFrame frame)
void	physicalSend(StompFrame frame)
void	ping(StompFrame pingFrame)
boolean	removeCloseListener(CloseListener listener) remove a Close Listener
List<CloseListener>	removeCloseListeners()
boolean	removeFailureListener(FailureListener listener) remove the failure listener
List<FailureListener>	removeFailureListeners()
void	sendFrame(StompFrame frame)
protected void	sendServerMessage(ServerMessageImpl message, String txID)
void	setClientID(String clientID)
void	setCloseListeners(List<CloseListener> listeners)
protected void	setDataReceived()
void	setFailureListeners(List<FailureListener> listeners) set the failure listeners.
void	setHost(String host)
void	setValid(boolean valid)
void	unsubscribe(String subscriptionID, String durableSubscriptionName)
protected void	validate()
boolean	validateUser(String login, String pass, X509Certificate[] certificates)

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTION_ID_PROP

protected static final String CONNECTION_ID_PROP

See Also:

Constant Field Values

Method Detail

isSupportReconnect

public boolean isSupportReconnect()

Description copied from interface: RemotingConnection

This will check if reconnects are supported on the protocol and configuration. In case it's not supported a connection failure could remove messages right away from pending deliveries.

Specified by:

isSupportReconnect in interface RemotingConnection

Returns:

decode

public StompFrame decode(ActiveMQBuffer buffer)
                  throws ActiveMQStompException

Throws:

ActiveMQStompException

isWritable

public boolean isWritable(ReadyListener callback)

Specified by:

isWritable in interface RemotingConnection

hasBytes

public boolean hasBytes()

addFailureListener

public void addFailureListener(FailureListener listener)

Description copied from interface: RemotingConnection

add a failure listener.

The listener will be called in the event of connection failure.

Specified by:

addFailureListener in interface RemotingConnection

Parameters:

listener - the listener

removeFailureListener

public boolean removeFailureListener(FailureListener listener)

Description copied from interface: RemotingConnection

remove the failure listener

Specified by:

removeFailureListener in interface RemotingConnection

Parameters:

listener - the lister to remove

Returns:

true if removed

addCloseListener

public void addCloseListener(CloseListener listener)

Description copied from interface: RemotingConnection

add a CloseListener.

This will be called in the event of the connection being closed.

Specified by:

addCloseListener in interface RemotingConnection

Parameters:

listener - the listener to add

removeCloseListener

public boolean removeCloseListener(CloseListener listener)

Description copied from interface: RemotingConnection

remove a Close Listener

Specified by:

removeCloseListener in interface RemotingConnection

Parameters:

listener - the listener to remove

Returns:

true if removed

removeCloseListeners

public List<CloseListener> removeCloseListeners()

Specified by:

removeCloseListeners in interface RemotingConnection

removeFailureListeners

public List<FailureListener> removeFailureListeners()

Specified by:

removeFailureListeners in interface RemotingConnection

setCloseListeners

public void setCloseListeners(List<CloseListener> listeners)

Specified by:

setCloseListeners in interface RemotingConnection

setFailureListeners

public void setFailureListeners(List<FailureListener> listeners)

Description copied from interface: RemotingConnection

set the failure listeners.

These will be called in the event of the connection being closed. Any previosuly added listeners will be removed.

Specified by:

setFailureListeners in interface RemotingConnection

Parameters:

listeners - the listeners to add.

setDataReceived

protected void setDataReceived()

checkDataReceived

public boolean checkDataReceived()

Description copied from interface: RemotingConnection

returns true if any data has been received since the last time this method was called.

Specified by:

checkDataReceived in interface RemotingConnection

Returns:

true if data has been received.

checkDestination

public void checkDestination(String destination)
                      throws ActiveMQStompException

Throws:

ActiveMQStompException

autoCreateDestinationIfPossible

public void autoCreateDestinationIfPossible(String queue)
                                     throws ActiveMQStompException

Throws:

ActiveMQStompException

createTransportBuffer

public ActiveMQBuffer createTransportBuffer(int size)

Description copied from interface: RemotingConnection

creates a new ActiveMQBuffer of the specified size. For the purpose of i/o outgoing packets

Specified by:

createTransportBuffer in interface RemotingConnection

Parameters:

size - the size of buffer required

Returns:

the buffer

destroy

public void destroy()

Description copied from interface: RemotingConnection

destroys this connection.

Specified by:

destroy in interface RemotingConnection

getAcceptorUsed

public Acceptor getAcceptorUsed()

fail

public void fail(ActiveMQException me)

Description copied from interface: RemotingConnection

called when the underlying connection fails.

Specified by:

fail in interface RemotingConnection

Parameters:

me - the exception that caused the failure

fail

public void fail(ActiveMQException me,
                 String scaleDownTargetNodeID)

Description copied from interface: RemotingConnection

called when the underlying connection fails.

Specified by:

fail in interface RemotingConnection

Parameters:

me - the exception that caused the failure

scaleDownTargetNodeID - the ID of the node where scale down is targeted

flush

public void flush()

Description copied from interface: RemotingConnection

flush all outstanding data from the connection.

Specified by:

flush in interface RemotingConnection

getFailureListeners

public List<FailureListener> getFailureListeners()

Description copied from interface: RemotingConnection

return all the failure listeners

Specified by:

getFailureListeners in interface RemotingConnection

Returns:

the listeners

getID

public Object getID()

Description copied from interface: RemotingConnection

Returns the unique id of the RemotingConnection.

Specified by:

getID in interface RemotingConnection

Returns:

the id

getRemoteAddress

public String getRemoteAddress()

Description copied from interface: RemotingConnection

returns a string representation of the remote address of this connection

Specified by:

getRemoteAddress in interface RemotingConnection

Returns:

the remote address

getCreationTime

public long getCreationTime()

Description copied from interface: RemotingConnection

Returns the creation time of the RemotingConnection.

Specified by:

getCreationTime in interface RemotingConnection

getTransportConnection

public Connection getTransportConnection()

Description copied from interface: RemotingConnection

return the underlying Connection.

Specified by:

getTransportConnection in interface RemotingConnection

Returns:

the connection

isClient

public boolean isClient()

Description copied from interface: RemotingConnection

Returns whether or not the RemotingConnection is a client

Specified by:

isClient in interface RemotingConnection

Returns:

true if client, false if a server

isDestroyed

public boolean isDestroyed()

Description copied from interface: RemotingConnection

Returns true if this RemotingConnection has been destroyed.

Specified by:

isDestroyed in interface RemotingConnection

Returns:

true if destroyed, otherwise false

bufferReceived

public void bufferReceived(Object connectionID,
                           ActiveMQBuffer buffer)

Description copied from interface: BufferHandler

called by the remoting connection when a buffer is received.

Specified by:

bufferReceived in interface BufferHandler

Parameters:

connectionID - the connection the buffer was received on

buffer - the buffer to decode

getLogin

public String getLogin()

getPasscode

public String getPasscode()

setClientID

public void setClientID(String clientID)

getClientID

public String getClientID()

isValid

public boolean isValid()

setValid

public void setValid(boolean valid)

negotiateVersion

public void negotiateVersion(StompFrame frame)
                      throws ActiveMQStompException

Throws:

ActiveMQStompException

setHost

public void setHost(String host)
             throws ActiveMQStompException

Throws:

ActiveMQStompException

handleFrame

public void handleFrame(StompFrame request)

sendFrame

public void sendFrame(StompFrame frame)

validateUser

public boolean validateUser(String login,
                            String pass,
                            X509Certificate[] certificates)

createServerMessage

public ServerMessageImpl createServerMessage()

getSession

public StompSession getSession(String txID)
                        throws ActiveMQStompException

Throws:

ActiveMQStompException

validate

protected void validate()
                 throws ActiveMQStompException

Throws:

ActiveMQStompException

sendServerMessage

protected void sendServerMessage(ServerMessageImpl message,
                                 String txID)
                          throws ActiveMQStompException

Throws:

ActiveMQStompException

disconnect

public void disconnect(boolean criticalError)

Description copied from interface: RemotingConnection

Disconnect the connection, closing all channels

Specified by:

disconnect in interface RemotingConnection

disconnect

public void disconnect(String scaleDownNodeID,
                       boolean criticalError)

Description copied from interface: RemotingConnection

Disconnect the connection, closing all channels

Specified by:

disconnect in interface RemotingConnection

beginTransaction

protected void beginTransaction(String txID)
                         throws ActiveMQStompException

Throws:

ActiveMQStompException

commitTransaction

public void commitTransaction(String txID)
                       throws ActiveMQStompException

Throws:

ActiveMQStompException

abortTransaction

public void abortTransaction(String txID)
                      throws ActiveMQStompException

Throws:

ActiveMQStompException

unsubscribe

public void unsubscribe(String subscriptionID,
                        String durableSubscriptionName)
                 throws ActiveMQStompException

Throws:

ActiveMQStompException

acknowledge

public void acknowledge(String messageID,
                        String subscriptionID)
                 throws ActiveMQStompException

Throws:

ActiveMQStompException

getVersion

public String getVersion()

getActiveMQServerName

public String getActiveMQServerName()

createStompMessage

public StompFrame createStompMessage(ServerMessage serverMessage,
                                     StompSubscription subscription,
                                     int deliveryCount)
                              throws Exception

Throws:

Exception

addStompEventListener

public void addStompEventListener(FrameEventListener listener)

ping

public void ping(StompFrame pingFrame)

physicalSend

public void physicalSend(StompFrame frame)
                  throws Exception

Throws:

Exception

getFrameHandler

public VersionedStompFrameHandler getFrameHandler()

enableMessageID

public boolean enableMessageID()

getMinLargeMessageSize

public int getMinLargeMessageSize()

getManager

public StompProtocolManager getManager()

killMessage

public void killMessage(SimpleString nodeID)

Description copied from interface: RemotingConnection

if slow consumer is killed,send the msessage to client.

Specified by:

killMessage in interface RemotingConnection