com.threerings.presents.net
Class AuthRequest

java.lang.Object
  extended by com.threerings.io.SimpleStreamableObject
      extended by com.threerings.presents.net.Message
          extended by com.threerings.presents.net.UpstreamMessage
              extended by com.threerings.presents.net.AuthRequest
All Implemented Interfaces:
Streamable

public class AuthRequest
extends UpstreamMessage

Used to authenticate with the server.


Field Summary
protected  String[] _bootGroups
          The set of bootstrap service groups this client is interested in.
protected  Credentials _creds
          The credentials associated with this auth request.
protected  String _version
          The version information associated with the client code.
protected  String _zone
          The timezone in which this client is operating.
 
Fields inherited from class com.threerings.presents.net.UpstreamMessage
_nextMessageId, messageId
 
Fields inherited from class com.threerings.presents.net.Message
received
 
Constructor Summary
AuthRequest()
          Zero argument constructor used when unserializing an instance.
AuthRequest(Credentials creds, String version, String[] bootGroups)
          Constructs a auth request with the supplied credentials and client version information.
 
Method Summary
 String[] getBootGroups()
          Returns the set of bootstrap service groups in which this client is interested.
 Credentials getCredentials()
          Returns a reference to the credentials provided with this request.
 TimeZone getTimeZone()
          Returns the timezone in which this client is operating.
 String getVersion()
          Returns a reference to the version information provided with this request.
 void readObject(ObjectInputStream in)
          Reads our custom streamable fields.
 String toString()
           
 
Methods inherited from class com.threerings.presents.net.UpstreamMessage
nextMessageId
 
Methods inherited from class com.threerings.presents.net.Message
getTransport, noteActualTransport, setTransport
 
Methods inherited from class com.threerings.io.SimpleStreamableObject
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_creds

protected Credentials _creds
The credentials associated with this auth request.


_version

protected String _version
The version information associated with the client code.


_zone

protected String _zone
The timezone in which this client is operating.


_bootGroups

protected String[] _bootGroups
The set of bootstrap service groups this client is interested in.

Constructor Detail

AuthRequest

public AuthRequest()
Zero argument constructor used when unserializing an instance.


AuthRequest

public AuthRequest(Credentials creds,
                   String version,
                   String[] bootGroups)
Constructs a auth request with the supplied credentials and client version information.

Method Detail

getCredentials

public Credentials getCredentials()
Returns a reference to the credentials provided with this request.


getVersion

public String getVersion()
Returns a reference to the version information provided with this request.


getTimeZone

public TimeZone getTimeZone()
Returns the timezone in which this client is operating.


getBootGroups

public String[] getBootGroups()
Returns the set of bootstrap service groups in which this client is interested.


toString

public String toString()
Overrides:
toString in class UpstreamMessage

readObject

public void readObject(ObjectInputStream in)
                throws IOException,
                       ClassNotFoundException
Reads our custom streamable fields.

Throws:
IOException
ClassNotFoundException