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

Interface RemotingService

All Known Implementing Classes:

RemotingServiceImpl

public interface RemotingService

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.
Acceptor	createAcceptor(String name, String uri)
Acceptor	createAcceptor(TransportConfiguration transportConfiguration)
void	destroyAcceptor(String name)
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.
Map<String,Acceptor>	getAcceptors()
default int	getConnectionCount()
ReusableLatch	getConnectionCountLatch()
Set<RemotingConnection>	getConnections()
List<BaseInterceptor>	getIncomingInterceptors()
List<BaseInterceptor>	getOutgoinInterceptors()
Map<String,ProtocolManagerFactory>	getProtocolFactoryMap()
long	getTotalConnectionCount()
boolean	isPaused()	Pauses the acceptors so that no more connections can be made to the server
boolean	isStarted()
void	loadProtocolServices(List<ActiveMQComponent> protocolServices)
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(BaseInterceptor interceptor)
boolean	removeOutgoingInterceptor(BaseInterceptor 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()

getConnectionCount

default int getConnectionCount()

Returns:

the number of clients connected to this server.

getTotalConnectionCount

long getTotalConnectionCount()

Returns:

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

getConnectionCountLatch

ReusableLatch getConnectionCountLatch()

addIncomingInterceptor

void addIncomingInterceptor(BaseInterceptor interceptor)

getIncomingInterceptors

List<BaseInterceptor> getIncomingInterceptors()

addOutgoingInterceptor

void addOutgoingInterceptor(BaseInterceptor interceptor)

getOutgoinInterceptors

List<BaseInterceptor> getOutgoinInterceptors()

removeIncomingInterceptor

boolean removeIncomingInterceptor(BaseInterceptor interceptor)

removeOutgoingInterceptor

boolean removeOutgoingInterceptor(BaseInterceptor 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()

getProtocolFactoryMap

Map<String,ProtocolManagerFactory> getProtocolFactoryMap()

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

getAcceptors

Map<String,Acceptor> getAcceptors()

createAcceptor

Acceptor createAcceptor(String name,
                        String uri)
                 throws Exception

Throws:

Exception

createAcceptor

Acceptor createAcceptor(TransportConfiguration transportConfiguration)

destroyAcceptor

void destroyAcceptor(String name)
              throws Exception

Throws:

Exception

loadProtocolServices

void loadProtocolServices(List<ActiveMQComponent> protocolServices)

addConnectionEntry

void addConnectionEntry(Connection connection,
                        ConnectionEntry entry)