Files
narya/src/java/com/threerings/presents/net/AuthRequest.java
T
Dave Hoover 657aafaedb And of course, if I were thinking this morning, I would've rerun the organize imports
thing before committing instead of just going "oh yeah, I've been having this stuff
sitting around uncommitted for a while waiting on it to be blessed" and missing
out on things that'd changed in the meantime.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5400 542714f4-19e9-0310-aa3c-eee0fc999fb1
2008-09-26 17:35:29 +00:00

120 lines
3.3 KiB
Java

//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2007 Three Rings Design, Inc., All Rights Reserved
// http://www.threerings.net/code/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package com.threerings.presents.net;
import java.util.TimeZone;
import java.io.IOException;
import com.threerings.io.ObjectInputStream;
/**
* Used to authenticate with the server.
*/
public class AuthRequest extends UpstreamMessage
{
/**
* Zero argument constructor used when unserializing an instance.
*/
public AuthRequest ()
{
super();
}
/**
* Constructs a auth request with the supplied credentials and client version information.
*/
public AuthRequest (Credentials creds, String version, String[] bootGroups)
{
_creds = creds;
_version = version;
_zone = TimeZone.getDefault().getID();
_bootGroups = bootGroups;
}
/**
* Returns a reference to the credentials provided with this request.
*/
public Credentials getCredentials ()
{
return _creds;
}
/**
* Returns a reference to the version information provided with this request.
*/
public String getVersion ()
{
return _version;
}
/**
* Returns the timezone in which this client is operating.
*/
public TimeZone getTimeZone ()
{
return TimeZone.getTimeZone(_zone);
}
/**
* Returns the set of bootstrap service groups in which this client is interested.
*/
public String[] getBootGroups ()
{
return _bootGroups;
}
@Override
public String toString ()
{
return "[type=AREQ, msgid=" + messageId + ", creds=" + _creds +
", version=" + _version + "]";
}
/**
* Reads our custom streamable fields.
*/
public void readObject (ObjectInputStream in)
throws IOException, ClassNotFoundException
{
try {
in.defaultReadObject();
} catch (IOException ioe) {
// if we fail here because the client is old, leave ourselves with a partially
// initialized set of credentials, which the server will generally cope with by telling
// the client it is out of date
}
}
/** The credentials associated with this auth request. */
protected Credentials _creds;
/** The version information associated with the client code. */
protected String _version;
/** The timezone in which this client is operating. */
protected String _zone;
/** The set of bootstrap service groups this client is interested in. */
protected String[] _bootGroups;
}