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

Class RemotingServiceImpl

java.lang.Object

org.apache.activemq.artemis.core.remoting.server.impl.RemotingServiceImpl

All Implemented Interfaces:

RemotingService, ConnectionLifeCycleListener

public class RemotingServiceImpl
extends Object
implements RemotingService, ConnectionLifeCycleListener

Field Summary

Fields

Modifier and Type	Field and Description
static long	CONNECTION_TTL_CHECK_INTERVAL

Constructor Summary

Constructors

Constructor and Description
RemotingServiceImpl(ClusterManager clusterManager, Configuration config, ActiveMQServer server, ManagementService managementService, ScheduledExecutorService scheduledThreadPool, List<ProtocolManagerFactory> protocolManagerFactories, Executor flushExecutor, ServiceRegistry serviceRegistry)

Method Summary

Modifier and Type	Method and Description
void	addIncomingInterceptor(Interceptor interceptor)
void	addOutgoingInterceptor(Interceptor interceptor)
void	allowInvmSecurityOverride(ActiveMQPrincipal principal) Allow acceptors to use this as their default security Principal if applicable.
void	connectionCreated(ActiveMQComponent component, Connection connection, String protocol) This method is used both by client connector creation and server connection creation through acceptors.
void	connectionDestroyed(Object connectionID) Called when a connection is destroyed.
void	connectionException(Object connectionID, ActiveMQException me) Called when an error occurs on the connection.
void	connectionReadyForWrites(Object connectionID, boolean ready)
void	freeze(String scaleDownNodeID, CoreRemotingConnection connectionToKeepOpen) Freezes and then disconnects all connections except the given one and tells the client where else it might connect (only applicable if server is in a cluster and uses scaleDown-on-failover=true).
Acceptor	getAcceptor(String name) Returns the acceptor identified by its name or null if it does not exists.
ReusableLatch	getConnectionCountLatch()
Set<RemotingConnection>	getConnections()
List<BaseInterceptor>	getIncomingInterceptors()
List<BaseInterceptor>	getOutgoinInterceptors()
boolean	isPaused() Pauses the acceptors so that no more connections can be made to the server
boolean	isStarted()
void	pauseAcceptors() Pauses the acceptors so that no more connections can be made to the server
RemotingConnection	removeConnection(Object remotingConnectionID) Remove a connection from the connections held by the remoting service.
boolean	removeIncomingInterceptor(Interceptor interceptor)
boolean	removeOutgoingInterceptor(Interceptor interceptor)
void	start()
void	startAcceptors()
void	stop(boolean criticalError)
protected void	updateProtocols()

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTION_TTL_CHECK_INTERVAL

public static final long CONNECTION_TTL_CHECK_INTERVAL

See Also:

Constant Field Values

Constructor Detail

RemotingServiceImpl

public RemotingServiceImpl(ClusterManager clusterManager,
                           Configuration config,
                           ActiveMQServer server,
                           ManagementService managementService,
                           ScheduledExecutorService scheduledThreadPool,
                           List<ProtocolManagerFactory> protocolManagerFactories,
                           Executor flushExecutor,
                           ServiceRegistry serviceRegistry)

Method Detail

start

public void start()
           throws Exception

Specified by:

start in interface RemotingService

Throws:

Exception

startAcceptors

public void startAcceptors()
                    throws Exception

Specified by:

startAcceptors in interface RemotingService

Throws:

Exception

allowInvmSecurityOverride

public void allowInvmSecurityOverride(ActiveMQPrincipal principal)

Description copied from interface: RemotingService

Allow acceptors to use this as their default security Principal if applicable.

Used by AS7 integration code.

Specified by:

allowInvmSecurityOverride in interface RemotingService

pauseAcceptors

public void pauseAcceptors()

Description copied from interface: RemotingService

Pauses the acceptors so that no more connections can be made to the server

Specified by:

pauseAcceptors in interface RemotingService

isPaused

public boolean isPaused()

Description copied from interface: RemotingService

Pauses the acceptors so that no more connections can be made to the server

Specified by:

isPaused in interface RemotingService

freeze

public void freeze(String scaleDownNodeID,
                   CoreRemotingConnection connectionToKeepOpen)

Description copied from interface: RemotingService

Freezes and then disconnects all connections except the given one and tells the client where else it might connect (only applicable if server is in a cluster and uses scaleDown-on-failover=true).

Specified by:

freeze in interface RemotingService

stop

public void stop(boolean criticalError)
          throws Exception

Specified by:

stop in interface RemotingService

Throws:

Exception

getAcceptor

public Acceptor getAcceptor(String name)

Description copied from interface: RemotingService

Returns the acceptor identified by its name or null if it does not exists.

Specified by:

getAcceptor in interface RemotingService

Parameters:

name - the name of the acceptor

isStarted

public boolean isStarted()

Specified by:

isStarted in interface RemotingService

removeConnection

public RemotingConnection removeConnection(Object remotingConnectionID)

Description copied from interface: RemotingService

Remove a connection from the connections held by the remoting service. This method must be used only from the management API. RemotingConnections are removed from the remoting service when their connectionTTL is hit.

Specified by:

removeConnection in interface RemotingService

Parameters:

remotingConnectionID - the ID of the RemotingConnection to removed

Returns:

the removed RemotingConnection

getConnections

public Set<RemotingConnection> getConnections()

Specified by:

getConnections in interface RemotingService

getConnectionCountLatch

public ReusableLatch getConnectionCountLatch()

Specified by:

getConnectionCountLatch in interface RemotingService

connectionCreated

public void connectionCreated(ActiveMQComponent component,
                              Connection connection,
                              String protocol)

Description copied from interface: ConnectionLifeCycleListener

This method is used both by client connector creation and server connection creation through acceptors. On the client side the component parameter is normally passed as null.

Leaving this method here and adding a different one at ServerConnectionLifeCycleListener is a compromise for a reasonable split between the activemq-server and activemq-client packages while avoiding to pull too much into activemq-core. The pivotal point keeping us from removing the method is ConnectorFactory and the usage of it.

Specified by:

connectionCreated in interface ConnectionLifeCycleListener

Parameters:

component - This will probably be an Acceptor and only used on the server side.

connection - the connection that has been created

protocol - the messaging protocol type this connection uses

connectionDestroyed

public void connectionDestroyed(Object connectionID)

Description copied from interface: ConnectionLifeCycleListener

Called when a connection is destroyed.

Specified by:

connectionDestroyed in interface ConnectionLifeCycleListener

Parameters:

connectionID - the connection being destroyed.

connectionException

public void connectionException(Object connectionID,
                                ActiveMQException me)

Description copied from interface: ConnectionLifeCycleListener

Called when an error occurs on the connection.

Specified by:

connectionException in interface ConnectionLifeCycleListener

Parameters:

connectionID - the id of the connection.

me - the exception.

connectionReadyForWrites

public void connectionReadyForWrites(Object connectionID,
                                     boolean ready)

Specified by:

connectionReadyForWrites in interface ConnectionLifeCycleListener

addIncomingInterceptor

public void addIncomingInterceptor(Interceptor interceptor)

Specified by:

addIncomingInterceptor in interface RemotingService

getIncomingInterceptors

public List<BaseInterceptor> getIncomingInterceptors()

Specified by:

getIncomingInterceptors in interface RemotingService

removeIncomingInterceptor

public boolean removeIncomingInterceptor(Interceptor interceptor)

Specified by:

removeIncomingInterceptor in interface RemotingService

addOutgoingInterceptor

public void addOutgoingInterceptor(Interceptor interceptor)

Specified by:

addOutgoingInterceptor in interface RemotingService

getOutgoinInterceptors

public List<BaseInterceptor> getOutgoinInterceptors()

Specified by:

getOutgoinInterceptors in interface RemotingService

removeOutgoingInterceptor

public boolean removeOutgoingInterceptor(Interceptor interceptor)

Specified by:

removeOutgoingInterceptor in interface RemotingService

updateProtocols

protected void updateProtocols()