org.elkoserver.server.context.test

Class EchoMod

java.lang.Object

org.elkoserver.server.context.Mod

org.elkoserver.server.context.test.EchoMod

All Implemented Interfaces:

Cloneable, DispatchTarget, Encodable, ContextMod, ObjectCompletionWatcher

public class EchoMod
extends Mod
implements ContextMod, ObjectCompletionWatcher

Mod to enable a context user to exercise the external 'echo' service.

Constructor Summary

Constructors

Constructor and Description
EchoMod() JSON-driven constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	echo(User from, String text) Message handler for the 'echo' message.
JSONLiteral	encode(EncodeControl control) Encode this mod for transmission or persistence.
void	objectIsComplete() Take notice that the associated context is complete.
void	status(User from) Message handler for the 'status' message.

Methods inherited from class org.elkoserver.server.context.Mod

attachTo, clone, context, ensureHolding, ensureInContext, ensureReachable, ensureSameContext, ensureSameUser, holder, isEphemeral, markAsChanged, markAsEphemeral, object

Methods inherited from class java.lang.Object

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

Constructor Detail

EchoMod

@JSONMethod
public EchoMod()

JSON-driven constructor.

Method Detail

encode

public JSONLiteral encode(EncodeControl control)

Encode this mod for transmission or persistence.

Specified by:

encode in interface Encodable

Parameters:

control - Encode control determining what flavor of encoding should be done.

Returns:

a JSON literal representing this mod.

echo

@JSONMethod(value="text")
public void echo(User from,
                        String text)
          throws MessageHandlerException

Message handler for the 'echo' message. This invokes the external echo service, if possible.

Throws:

MessageHandlerException

status

@JSONMethod
public void status(User from)
            throws MessageHandlerException

Message handler for the 'status' message. This requests a report on the state of the echo client connection.

Throws:

MessageHandlerException

objectIsComplete

public void objectIsComplete()

Take notice that the associated context is complete. In this case, we lookup the echo client object from the environment, now that (since the context is complete) there is an environment to look it up from.

Specified by:

objectIsComplete in interface ObjectCompletionWatcher