Package 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, BaseConnectionLifeCycleListener<ProtocolManager>, ServerConnectionLifeCycleListener

public class RemotingServiceImpl
extends Object
implements RemotingService, ServerConnectionLifeCycleListener

Constructor Summary

Constructors

Constructor	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	Description
void	addConnectionEntry(Connection connection, ConnectionEntry entry)
void	addIncomingInterceptor(BaseInterceptor interceptor)
void	addOutgoingInterceptor(BaseInterceptor interceptor)
void	allowInvmSecurityOverride(ActiveMQPrincipal principal)	Allow acceptors to use this as their default security Principal if applicable.
void	connectionCreated(ActiveMQComponent component, Connection connection, ProtocolManager protocol)	This method is used both by client connector creation and server connection creation through acceptors.
void	connectionDestroyed(Object connectionID, boolean failed)	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)
Acceptor	createAcceptor(String name, String uri)
Acceptor	createAcceptor(TransportConfiguration info)
void	destroyAcceptor(String name)
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.
Map<String,Acceptor>	getAcceptors()
RemotingConnection	getConnection(Object remotingConnectionID)
int	getConnectionCount()	Returns the number of clients connected to this server.
ReusableLatch	getConnectionCountLatch()
Set<ConnectionEntry>	getConnectionEntries()
ConnectionEntry	getConnectionEntry(Object remotingConnectionID)
Set<RemotingConnection>	getConnections()
List<BaseInterceptor>	getIncomingInterceptors()
List<BaseInterceptor>	getOutgoinInterceptors()
Map<String,ProtocolManagerFactory>	getProtocolFactoryMap()
long	getTotalConnectionCount()	Returns the number of clients which have connected to this server since it was started.
boolean	isPaused()	Pauses the acceptors so that no more connections can be made to the server
boolean	isStarted()
void	loadProtocolServices(List<ActiveMQComponent> protocolServices)
void	notifyStop()
void	pauseAcceptors()	Pauses the acceptors so that no more connections can be made to the server
void	prepareStop(boolean criticalError, Set<RemotingConnection> ignoreList)	The Prepare stop will close all the connections however it will use the one used by storage manager
RemotingConnection	removeConnection(Object remotingConnectionID)	Remove a connection from the connections held by the remoting service.
boolean	removeIncomingInterceptor(BaseInterceptor interceptor)
boolean	removeOutgoingInterceptor(BaseInterceptor interceptor)
void	start()
void	startAcceptors()
void	stop(boolean criticalError)
protected void	updateProtocols()
void	updateProtocolServices(List<ActiveMQComponent> protocolServices)	Provides an entry point for protocol services offered by this service instance to react to configuration updates.

Methods inherited from class java.lang.Object

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

Constructor Details

RemotingServiceImpl

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

Method Details

getProtocolFactoryMap

public Map<String,ProtocolManagerFactory> getProtocolFactoryMap()

Specified by:

getProtocolFactoryMap in interface RemotingService

start

public void start()
           throws Exception

Specified by:

start in interface RemotingService

Throws:

Exception

createAcceptor

public Acceptor createAcceptor(String name,
 String uri)
                        throws Exception

Specified by:

createAcceptor in interface RemotingService

Throws:

Exception

createAcceptor

public Acceptor createAcceptor(TransportConfiguration info)

Specified by:

createAcceptor in interface RemotingService

getAcceptors

public Map<String,Acceptor> getAcceptors()

Specified by:

getAcceptors in interface RemotingService

destroyAcceptor

public void destroyAcceptor(String name)
                     throws Exception

Specified by:

destroyAcceptor 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

notifyStop

public void notifyStop()

Specified by:

notifyStop in interface RemotingService

prepareStop

public void prepareStop(boolean criticalError,
 Set<RemotingConnection> ignoreList)
                 throws Exception

Description copied from interface: RemotingService

The Prepare stop will close all the connections however it will use the one used by storage manager

Specified by:

prepareStop in interface RemotingService

Throws:

Exception

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

Returns:

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

isStarted

public boolean isStarted()

Specified by:

isStarted in interface RemotingService

getConnection

public RemotingConnection getConnection(Object remotingConnectionID)

Specified by:

getConnection in interface RemotingService

getConnectionEntry

public ConnectionEntry getConnectionEntry(Object remotingConnectionID)

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

getConnectionEntries

public Set<ConnectionEntry> getConnectionEntries()

getConnectionCount

public int getConnectionCount()

Description copied from interface: RemotingService

Returns the number of clients connected to this server.

Specified by:

getConnectionCount in interface RemotingService

Returns:

the number of clients connected to this server

getTotalConnectionCount

public long getTotalConnectionCount()

Description copied from interface: RemotingService

Returns the number of clients which have connected to this server since it was started.

Specified by:

getTotalConnectionCount in interface RemotingService

Returns:

the number of clients which have connected to this server since it was started

getConnectionCountLatch

public ReusableLatch getConnectionCountLatch()

Specified by:

getConnectionCountLatch in interface RemotingService

loadProtocolServices

public void loadProtocolServices(List<ActiveMQComponent> protocolServices)

Specified by:

loadProtocolServices in interface RemotingService

updateProtocolServices

public void updateProtocolServices(List<ActiveMQComponent> protocolServices)
                            throws Exception

Description copied from interface: RemotingService

Provides an entry point for protocol services offered by this service instance to react to configuration updates. If the service implementation does not have any managed services or its services do not respond to updates it can ignore this call. services added should be added to the provided protocolServices list, and any removed should be found and removed from the list.

Specified by:

updateProtocolServices in interface RemotingService

Parameters:

protocolServices - The list of protocol services known to the broker.

Throws:

Exception - if an error is thrown during the services updates.

connectionCreated

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

Description copied from interface: BaseConnectionLifeCycleListener

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 BaseConnectionLifeCycleListener<ProtocolManager>

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

addConnectionEntry

public void addConnectionEntry(Connection connection,
 ConnectionEntry entry)

Specified by:

addConnectionEntry in interface RemotingService

connectionDestroyed

public void connectionDestroyed(Object connectionID,
 boolean failed)

Description copied from interface: BaseConnectionLifeCycleListener

Called when a connection is destroyed.

Specified by:

connectionDestroyed in interface BaseConnectionLifeCycleListener<ProtocolManager>

Parameters:

connectionID - the connection being destroyed.

connectionException

public void connectionException(Object connectionID,
 ActiveMQException me)

Description copied from interface: BaseConnectionLifeCycleListener

Called when an error occurs on the connection.

Specified by:

connectionException in interface BaseConnectionLifeCycleListener<ProtocolManager>

Parameters:

connectionID - the id of the connection.

me - the exception.

connectionReadyForWrites

public void connectionReadyForWrites(Object connectionID,
 boolean ready)

Specified by:

connectionReadyForWrites in interface BaseConnectionLifeCycleListener<ProtocolManager>

addIncomingInterceptor

public void addIncomingInterceptor(BaseInterceptor interceptor)

Specified by:

addIncomingInterceptor in interface RemotingService

getIncomingInterceptors

public List<BaseInterceptor> getIncomingInterceptors()

Specified by:

getIncomingInterceptors in interface RemotingService

removeIncomingInterceptor

public boolean removeIncomingInterceptor(BaseInterceptor interceptor)

Specified by:

removeIncomingInterceptor in interface RemotingService

addOutgoingInterceptor

public void addOutgoingInterceptor(BaseInterceptor interceptor)

Specified by:

addOutgoingInterceptor in interface RemotingService

getOutgoinInterceptors

public List<BaseInterceptor> getOutgoinInterceptors()

Specified by:

getOutgoinInterceptors in interface RemotingService

removeOutgoingInterceptor

public boolean removeOutgoingInterceptor(BaseInterceptor interceptor)

Specified by:

removeOutgoingInterceptor in interface RemotingService

updateProtocols

protected void updateProtocols()