Package ej.rcommand.impl

Class DefaultRemoteCommandManager

java.lang.Object

ej.rcommand.impl.DefaultRemoteCommandManager

All Implemented Interfaces:

CommandSenderProvider, RemoteCommandManager

Direct Known Subclasses:

GatewayRemoteCommandManager

public class DefaultRemoteCommandManager
extends Object
implements RemoteCommandManager

Constructor Summary

Constructors

Constructor	Description
DefaultRemoteCommandManager()	Creates a default remote command manager.
DefaultRemoteCommandManager(boolean overwrite)	Creates a default remote command manager.

Method Summary

Modifier and Type	Method	Description
Collection<? extends CommandSender>	getCommandSenders(String command)	Returns the command senders that handle the given command.
protected RemoteCommandListener	getListenerFor(String command)	Returns the RemoteConnectionListener for the given command.
Collection<String>	getRegisteredCommands()	Gets the collections of registered commands with CommandSenderProvider.registerListener(RemoteCommandListener).
void	onError(RemoteConnection connection)	Called when an error occurs in the given connection
void	registerListener(RemoteCommandListener listener)	Registers a listener that will be called when command managed by the listener is read.
void	sendNotification(RemoteNotification notification)	Sends the given notification to all connected clients.
void	startReading(RemoteConnection connection)	Can be called once.
void	startReading(RemoteConnection connection, RemoteConnectionListener listener)	Can be called once.
void	startReading(RemoteConnection connection, String connectionName)	Can be called once.
void	startReading(RemoteConnection connection, String connectionName, RemoteConnectionListener listener)	Can be called once.
void	stopAll()	Stops all the connections.
void	stopReading(RemoteConnection connection)	Stops reading the commands from the given CommandReader.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRemoteCommandManager

public DefaultRemoteCommandManager(boolean overwrite)

Creates a default remote command manager.

It is possible to choose the policy when a listener is registered that manage the same command as another one. Either drop the new one or overwrite the old one.

Parameters:

overwrite - the listener policy, true to overwrite the old one, false otherwise.

DefaultRemoteCommandManager

public DefaultRemoteCommandManager()

Creates a default remote command manager.

Equivalent as calling DefaultRemoteCommandManager(boolean) with false as parameter.

Method Detail

registerListener

public void registerListener(RemoteCommandListener listener)
                      throws IllegalStateException

Description copied from interface: CommandSenderProvider

Registers a listener that will be called when command managed by the listener is read.

Specified by:

registerListener in interface CommandSenderProvider

Parameters:

listener - the listener to register

Throws:

IllegalStateException - if a listener is already registered for a command managed by the listener

getListenerFor

@Nullable
protected RemoteCommandListener getListenerFor(String command)

Returns the RemoteConnectionListener for the given command.

startReading

public void startReading(RemoteConnection connection)

Can be called once.

Specified by:

startReading in interface RemoteCommandManager

Parameters:

connection - the connection to read.

startReading

public void startReading(RemoteConnection connection,
                         RemoteConnectionListener listener)

Can be called once.

Specified by:

startReading in interface RemoteCommandManager

Parameters:

connection - the connection to read.

listener - the associated listener.

startReading

public void startReading(RemoteConnection connection,
                         String connectionName)

Can be called once.

Specified by:

startReading in interface RemoteCommandManager

Parameters:

connection - the connection to read.

connectionName - the name of the connection to read.

startReading

public void startReading(RemoteConnection connection,
                         String connectionName,
                         @Nullable
                         RemoteConnectionListener listener)

Can be called once.

Specified by:

startReading in interface RemoteCommandManager

Parameters:

connection - the connection to read.

connectionName - the name of the connection to read.

listener - the associated listener.

stopReading

public void stopReading(RemoteConnection connection)

Description copied from interface: RemoteCommandManager

Stops reading the commands from the given CommandReader.

Specified by:

stopReading in interface RemoteCommandManager

Parameters:

connection - the connection to stop to read.

onError

public void onError(RemoteConnection connection)

Called when an error occurs in the given connection

stopAll

public void stopAll()

Description copied from interface: RemoteCommandManager

Stops all the connections.

Specified by:

stopAll in interface RemoteCommandManager

getCommandSenders

public Collection<? extends CommandSender> getCommandSenders(String command)

Description copied from interface: CommandSenderProvider

Returns the command senders that handle the given command.

Synchronize on this CommandSenderProvider while using the returned collection to avoid concurrent modifications of the collection.

Specified by:

getCommandSenders in interface CommandSenderProvider

getRegisteredCommands

public Collection<String> getRegisteredCommands()

Description copied from interface: CommandSenderProvider

Gets the collections of registered commands with CommandSenderProvider.registerListener(RemoteCommandListener).

Specified by:

getRegisteredCommands in interface CommandSenderProvider

Returns:

the collections of registered commands

sendNotification

public void sendNotification(RemoteNotification notification)

Description copied from interface: RemoteCommandManager

Sends the given notification to all connected clients.

Specified by:

sendNotification in interface RemoteCommandManager

Parameters:

notification - the notification to send.