com.threerings.bureau.server

Class BureauRegistry

java.lang.Object

com.threerings.bureau.server.BureauRegistry

public class BureauRegistry
extends Object

Abstracts the launching and termination of external processes (bureaus) that host instances of server-side code (agents).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BureauRegistry.CommandGenerator Defines how to generate a command to launch a bureau in a local process.
static interface	BureauRegistry.Launcher Defines how a bureau is launched.

Constructor Summary

Constructors

Constructor and Description
BureauRegistry(InvocationManager invmgr, PresentsConnectionManager conmgr, ClientManager clmgr) Creates an uninitialized registry.

Method Summary

Modifier and Type	Method and Description
String	checkToken(BureauCredentials creds) Check the credentials to make sure this is one of our bureaus.
void	destroyAgent(AgentObject agent) Destroys a previously started agent using the data in the given object.
Exception	getLaunchError(AgentObject agentObj) If this agent's bureau encountered an error on launch, return it.
PresentsSession	lookupClient(String bureauId) Returns the active session for a bureau of the given id.
void	setCommandGenerator(String bureauType, BureauRegistry.CommandGenerator cmdGenerator) Registers a command generator for a given type.
void	setCommandGenerator(String bureauType, BureauRegistry.CommandGenerator cmdGenerator, int timeout) Registers a command generator for a given type.
void	setLauncher(String bureauType, BureauRegistry.Launcher launcher) Registers a launcher for a given type.
void	setLauncher(String bureauType, BureauRegistry.Launcher launcher, int timeout) Registers a launcher for a given type.
void	startAgent(AgentObject agent) Starts a new agent using the data in the given object, creating a new bureau if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

BureauRegistry

@Inject
public BureauRegistry(InvocationManager invmgr,
                              PresentsConnectionManager conmgr,
                              ClientManager clmgr)

Creates an uninitialized registry.

Method Detail

checkToken

public String checkToken(BureauCredentials creds)

Check the credentials to make sure this is one of our bureaus.

Returns:

null if all's well, otherwise a string describing the authentication failure

setCommandGenerator

public void setCommandGenerator(String bureauType,
                                BureauRegistry.CommandGenerator cmdGenerator)

Registers a command generator for a given type. When an agent is started and no bureaus are running, the bureauType is used to determine the CommandGenerator instance to call. The registry will wait indefinitely for the bureau to connect back.

Parameters:

bureauType - the type of bureau that will be launched

cmdGenerator - the generator to be used for bureaus of bureauType

setCommandGenerator

public void setCommandGenerator(String bureauType,
                                BureauRegistry.CommandGenerator cmdGenerator,
                                int timeout)

Registers a command generator for a given type. When an agent is started and no bureaus are running, the bureauType is used to determine the CommandGenerator instance to call. If the launched bureau does not connect within the given number of milliseconds, it will be logged as an error and future attempts to launch the bureau will try launching the command again.

Parameters:

bureauType - the type of bureau that will be launched

cmdGenerator - the generator to be used for bureaus of bureauType

timeout - milliseconds to wait for the bureau or 0 to wait forever

setLauncher

public void setLauncher(String bureauType,
                        BureauRegistry.Launcher launcher)

Registers a launcher for a given type. When an agent is started and no bureaus are running, the bureauType is used to determine the Launcher instance to call. The registry will wait indefinitely for the launched bureau to connect back.

Parameters:

bureauType - the type of bureau that will be launched

launcher - the launcher to be used for bureaus of bureauType

setLauncher

public void setLauncher(String bureauType,
                        BureauRegistry.Launcher launcher,
                        int timeout)

Registers a launcher for a given type. When an agent is started and no bureaus are running, the bureauType is used to determine the Launcher instance to call. If the launched bureau does not connect within the given number of milliseconds, it will be logged as an error and future attempts to launch the bureau will invoke the launch method again.

Parameters:

bureauType - the type of bureau that will be launched

launcher - the launcher to be used for bureaus of bureauType

timeout - milliseconds to wait for the bureau or 0 to wait forever

startAgent

public void startAgent(AgentObject agent)

Starts a new agent using the data in the given object, creating a new bureau if necessary.

destroyAgent

public void destroyAgent(AgentObject agent)

Destroys a previously started agent using the data in the given object.

lookupClient

public PresentsSession lookupClient(String bureauId)

Returns the active session for a bureau of the given id.

getLaunchError

public Exception getLaunchError(AgentObject agentObj)

If this agent's bureau encountered an error on launch, return it.