com.threerings.crowd.server

Class PlaceRegistry

java.lang.Object

com.threerings.crowd.server.PlaceRegistry

All Implemented Interfaces:

Lifecycle.BaseComponent, Lifecycle.ShutdownComponent

public class PlaceRegistry
extends Object
implements Lifecycle.ShutdownComponent

The place registry keeps track of all of the active places in the server. It should be used to create new places and it will take care of instantiating and initializing a place manager to manage newly created places.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PlaceRegistry.PreStartupHook Used in conjunction with createPlace(PlaceConfig,PreStartupHook).

Constructor Summary

Constructors

Constructor and Description
PlaceRegistry(Lifecycle cycle) Creates and initializes the place registry.

Method Summary

Modifier and Type	Method and Description
PlaceManager	createPlace(PlaceConfig config) Creates and registers a new place manager with no delegates.
PlaceManager	createPlace(PlaceConfig config, List<PlaceManagerDelegate> delegates) Creates and registers a new place manager along with the place object to be managed.
PlaceManager	createPlace(PlaceConfig config, PlaceRegistry.PreStartupHook hook) Don't use this method, see createPlace(PlaceConfig).
Iterator<PlaceManager>	enumeratePlaceManagers() Returns an enumeration of all of the registered place managers.
Iterator<PlaceObject>	enumeratePlaces() Returns an enumeration of all of the registered place objects.
PlaceManager	getPlaceManager(int placeOid) Returns the place manager associated with the specified place object id or null if no such place exists.
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceRegistry

@Inject
public PlaceRegistry(Lifecycle cycle)

Creates and initializes the place registry. This is called by the server during its initialization phase.

Method Detail

getPlaceManager

public PlaceManager getPlaceManager(int placeOid)

Returns the place manager associated with the specified place object id or null if no such place exists.

createPlace

public PlaceManager createPlace(PlaceConfig config)
                         throws InstantiationException,
                                InvocationException

Creates and registers a new place manager with no delegates.

Throws:

InstantiationException

InvocationException

See Also:

createPlace(PlaceConfig,List)

createPlace

public PlaceManager createPlace(PlaceConfig config,
                                List<PlaceManagerDelegate> delegates)
                         throws InstantiationException,
                                InvocationException

Creates and registers a new place manager along with the place object to be managed. The registry takes care of tracking the creation of the object and informing the manager when it is created.

Parameters:

config - the configuration object for the place to be created. The PlaceManager derived class that should be instantiated to manage the place will be determined from the config object.

delegates - a list of PlaceManagerDelegate instances to be registered with the manager prior to it being initialized and started up. Note: these delegates will have dependencies injected into them prior to registering them with the manager.

Returns:

a reference to the place manager, which will have been configured with its place object and started up (via a call to PlaceManager.startup(com.threerings.crowd.data.PlaceObject).

Throws:

InstantiationException - thrown if an error occurs trying to instantiate and initialize the place manager.

InvocationException - thrown if the place manager returns failure from the call to PlaceManager.checkPermissions(). The error string returned by that call will be provided as in the exception.

createPlace

public PlaceManager createPlace(PlaceConfig config,
                                PlaceRegistry.PreStartupHook hook)
                         throws InstantiationException,
                                InvocationException

Don't use this method, see createPlace(PlaceConfig).

Parameters:

hook - an optional pre-startup hook that allows a place manager to be configured prior to having PlaceManager.startup(com.threerings.crowd.data.PlaceObject) called. This mainly exists because it used to be possible to do such things. Try not to use this in new code.

Throws:

InstantiationException

InvocationException

enumeratePlaces

public Iterator<PlaceObject> enumeratePlaces()

Returns an enumeration of all of the registered place objects. This should only be accessed on the dobjmgr thread and shouldn't be kept around across event dispatches.

enumeratePlaceManagers

public Iterator<PlaceManager> enumeratePlaceManagers()

Returns an enumeration of all of the registered place managers. This should only be accessed on the dobjmgr thread and shouldn't be kept around across event dispatches.

shutdown

public void shutdown()

Specified by:

shutdown in interface Lifecycle.ShutdownComponent