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

Interface RemotingService

All Known Implementing Classes:

RemotingServiceImpl

public interface RemotingService

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	freeze(String scaleDownNodeID, CoreRemotingConnection remotingConnection) 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)

Method Detail

removeConnection

RemotingConnection removeConnection(Object remotingConnectionID)

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.

Parameters:

remotingConnectionID - the ID of the RemotingConnection to removed

Returns:

the removed RemotingConnection

getConnections

Set<RemotingConnection> getConnections()

getConnectionCountLatch

ReusableLatch getConnectionCountLatch()

addIncomingInterceptor

void addIncomingInterceptor(Interceptor interceptor)

getIncomingInterceptors

List<BaseInterceptor> getIncomingInterceptors()

addOutgoingInterceptor

void addOutgoingInterceptor(Interceptor interceptor)

getOutgoinInterceptors

List<BaseInterceptor> getOutgoinInterceptors()

removeIncomingInterceptor

boolean removeIncomingInterceptor(Interceptor interceptor)

removeOutgoingInterceptor

boolean removeOutgoingInterceptor(Interceptor interceptor)

stop

void stop(boolean criticalError)
   throws Exception

Throws:

Exception

start

void start()
    throws Exception

Throws:

Exception

startAcceptors

void startAcceptors()
             throws Exception

Throws:

Exception

isStarted

boolean isStarted()

allowInvmSecurityOverride

void allowInvmSecurityOverride(ActiveMQPrincipal principal)

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

Used by AS7 integration code.

Parameters:

principal -

pauseAcceptors

void pauseAcceptors()

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

isPaused

boolean isPaused()

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

freeze

void freeze(String scaleDownNodeID,
            CoreRemotingConnection remotingConnection)

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).

Parameters:

scaleDownNodeID -

remotingConnection -

getAcceptor

Acceptor getAcceptor(String name)

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

Parameters:

name - the name of the acceptor