org.elkoserver.server.context.test

Class GateController

java.lang.Object

org.elkoserver.server.context.Mod

org.elkoserver.server.context.test.GateController

All Implemented Interfaces:

Cloneable, DispatchTarget, Encodable, ContextMod

public class GateController
extends Mod
implements ContextMod

Mod to enable a context user to control the context's gate

Constructor Summary

Constructors

Constructor and Description
GateController() JSON-driven constructor.

Method Summary

Methods

Modifier and Type	Method and Description
JSONLiteral	encode(EncodeControl control) Encode this mod for transmission or persistence.
void	gate(User from, boolean open, OptString optReason) Message handler for the 'gate' 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

GateController

@JSONMethod
public GateController()

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.

gate

@JSONMethod(value={"open","reason"})
public void gate(User from,
                        boolean open,
                        OptString optReason)
          throws MessageHandlerException

Message handler for the 'gate' message.

Throws:

MessageHandlerException