Package org.powertac.common.msg

Class BrokerAccept

java.lang.Object

org.powertac.common.msg.BrokerAccept

public class BrokerAccept
extends Object

This message is used to signify that the broker authentication is accepted. Server sends this message to broker after successful validation of BrokerAuthentication message from the broker. Broker must use the prefix to initialize its IdGenerator. Note that the system time is acquired in the constructor. To maximize synchronization value, the delay between constructing and sending this message must be minimized.

Author:

John Collins

Constructor Summary

Constructors

Constructor	Description
BrokerAccept(int prefix)
BrokerAccept(int prefix, String key)

Method Summary

Modifier and Type	Method	Description
String	getKey()	Returns the jms key used to validate broker communications.
int	getPrefix()	Returns the ID prefix to be used by the broker.
long	getServerTime()	Returns the server's system time at the time this instance was created.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokerAccept

public BrokerAccept(int prefix)

BrokerAccept

public BrokerAccept(int prefix,
                    String key)

Method Detail

getPrefix

public int getPrefix()

Returns the ID prefix to be used by the broker. On receiving this message, a remote broker is responsible for calling IdGenerator.setPrefix(prefix).

getKey

public String getKey()

Returns the jms key used to validate broker communications. On receiving this message, a remote broker is responsible for calling broker.setKey(key) before sending messages to the server.

getServerTime

public long getServerTime()

Returns the server's system time at the time this instance was created.