com.threerings.crowd.server

Class PlaceManager

java.lang.Object

com.threerings.crowd.server.PlaceManager

All Implemented Interfaces:

SpeakHandler.SpeakerValidator, ChangeListener, MessageListener

public class PlaceManager
extends Object
implements MessageListener, SpeakHandler.SpeakerValidator

The place manager is the server-side entity that handles all place-related interaction. It subscribes to the place object and reacts to message and other events. Behavior specific to a place (or class of places) should live in the place manager. An intelligently constructed hierarchy of place manager classes working in concert with invocation services should provide the majority of the server-side functionality of an application built on the Presents platform.

The base place manager class takes care of the necessary interactions with the place registry to manage place registration. It handles the place-related component of chatting. It also provides the basis for place-based access control.

A derived class is expected to handle initialization, cleanup and operational functionality via the calldown functions didInit(), didStartup(), and didShutdown() as well as through event listeners.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlaceManager.DelegateOp Used to call methods on this place manager's delegates.
static interface	PlaceManager.MessageHandler Deprecated. Use dynamically bound methods instead. See DynamicListener.

Constructor Summary

Constructors

Constructor and Description
PlaceManager()

Method Summary

Modifier and Type	Method and Description
void	addDelegate(PlaceManagerDelegate delegate) Adds the supplied delegate to the list for this manager.
void	applyToDelegates(PlaceManager.DelegateOp op) Applies the supplied operation to this manager's registered delegates.
void	applyToOccupants(OccupantOp op) Applies the supplied occupant operation to each occupant currently present in this place.
void	bodyWillEnter(BodyObject body) This is called to inform the manager that a body is on the way in.
void	bodyWillLeave(BodyObject body) Called to inform a manager that a body is about to leave this place.
String	checkPermissions() Provides an opportunity for place managers to ratify the creation of a place based on whatever criterion they may require (based on information available to the manager at this post-init() but pre-startup() phase of initialization).
PlaceConfig	getConfig() Returns a reference to our place configuration object.
Place	getLocation() Returns a Place instance that identifies this place.
PlaceObject	getPlaceObject() Returns the place object managed by this place manager.
void	init(PlaceRegistry registry, InvocationManager invmgr, RootDObjectManager omgr, BodyLocator locator, PlaceConfig config) Called by the place registry after creating this place manager.
boolean	isValidSpeaker(DObject speakObj, ClientObject speaker, byte mode) Should return true if the supplied speaker is allowed to speak via the speak provider with which this validator was registered.
void	messageReceived(MessageEvent event) Called when an message event has been dispatched on an object.
String	ratifyBodyEntry(BodyObject body) Provides an opportunity for the place manager to prevent bodies from entering.
void	registerMessageHandler(String name, PlaceManager.MessageHandler handler) Deprecated. Use dynamically bound methods instead. See DynamicListener.
void	shutdown() Causes the place object being managed by this place manager to be destroyed and the place manager to shut down.
void	startup(PlaceObject plobj) Called by the place manager after the place object has been successfully created.
String	toString() Generates a string representation of this manager.
<T extends OccupantInfo> boolean	updateOccupantInfo(int bodyOid, OccupantInfo.Updater<T> updater) Calls the supplied updater on the canonical occupant info record for the specified body (which must be an occupant of this place) and broadcasts the update to all other occupants.
String	where() Returns a string that can be used in log messages to identify the place as sensibly as possible to the developer who has to puzzle over log output trying to figure out what's going on.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PlaceManager

public PlaceManager()

Method Detail

getConfig

public PlaceConfig getConfig()

Returns a reference to our place configuration object.

getLocation

public Place getLocation()

Returns a Place instance that identifies this place.

getPlaceObject

public PlaceObject getPlaceObject()

Returns the place object managed by this place manager.

applyToOccupants

public void applyToOccupants(OccupantOp op)

Applies the supplied occupant operation to each occupant currently present in this place.

updateOccupantInfo

public <T extends OccupantInfo> boolean updateOccupantInfo(int bodyOid,
                                                           OccupantInfo.Updater<T> updater)

Calls the supplied updater on the canonical occupant info record for the specified body (which must be an occupant of this place) and broadcasts the update to all other occupants.

Returns:

true if the updater was called and the update sent, false if the body could not be located (was not an occupant of this place) or the updater made no modifications.

Throws:

ClassCastException - thrown if the type of the supplied updater does not match the type of OccupantInfo record used for the occupant. Caveat utilitor.

init

public void init(PlaceRegistry registry,
                 InvocationManager invmgr,
                 RootDObjectManager omgr,
                 BodyLocator locator,
                 PlaceConfig config)

Called by the place registry after creating this place manager.

addDelegate

public void addDelegate(PlaceManagerDelegate delegate)

Adds the supplied delegate to the list for this manager.

applyToDelegates

public void applyToDelegates(PlaceManager.DelegateOp op)

Applies the supplied operation to this manager's registered delegates.

checkPermissions

public String checkPermissions()

Provides an opportunity for place managers to ratify the creation of a place based on whatever criterion they may require (based on information available to the manager at this post-init() but pre-startup() phase of initialization).

Returns:

If a permissions check is to fail, the manager should return a translatable string explaining the failure. null should be returned if initialization is to be allowed to proceed.

startup

public void startup(PlaceObject plobj)

Called by the place manager after the place object has been successfully created.

shutdown

public void shutdown()

Causes the place object being managed by this place manager to be destroyed and the place manager to shut down.

ratifyBodyEntry

public String ratifyBodyEntry(BodyObject body)

Provides an opportunity for the place manager to prevent bodies from entering.

Returns:

null if the body can enter, otherwise a translatable message explaining the reason the body is blocked from entering

bodyWillEnter

public void bodyWillEnter(BodyObject body)

This is called to inform the manager that a body is on the way in. This is called at the very beginning of the entry process before the client is informed that it is allowed to enter. This will be followed by a call to bodyEntered(int) once all events relating to body entry have been processed.

bodyWillLeave

public void bodyWillLeave(BodyObject body)

Called to inform a manager that a body is about to leave this place. This will be followed by a call to bodyLeft(int) once all events relating to body entry have been processed.

registerMessageHandler

@Deprecated
public void registerMessageHandler(String name,
                                               PlaceManager.MessageHandler handler)

Deprecated. Use dynamically bound methods instead. See DynamicListener.

Registers a particular message handler instance to be used when processing message events with the specified name.

Parameters:

name - the message name of the message events that should be handled by this handler.

handler - the handler to be registered.

messageReceived

public void messageReceived(MessageEvent event)

Description copied from interface: MessageListener

Called when an message event has been dispatched on an object.

Specified by:

messageReceived in interface MessageListener

Parameters:

event - The event that was dispatched on the object.

isValidSpeaker

public boolean isValidSpeaker(DObject speakObj,
                              ClientObject speaker,
                              byte mode)

Description copied from interface: SpeakHandler.SpeakerValidator

Should return true if the supplied speaker is allowed to speak via the speak provider with which this validator was registered.

Specified by:

isValidSpeaker in interface SpeakHandler.SpeakerValidator

where

public String where()

Returns a string that can be used in log messages to identify the place as sensibly as possible to the developer who has to puzzle over log output trying to figure out what's going on. Derived place managers can override this and augment the default value (which is simply the place object id) with useful identifying information.

toString

public String toString()

Generates a string representation of this manager. Does so in a way that makes it easier for derived classes to add to the string representation.

Overrides:

toString in class Object

See Also:

toString(StringBuilder)