git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@4665 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
2007-04-18 01:16:57 +00:00
parent 1ca159fe34
commit cefe7f0788
@@ -25,18 +25,16 @@ import com.threerings.io.Streamable;
import com.threerings.util.Name; import com.threerings.util.Name;
/** /**
* Credentials are supplied by the client implementation and sent along to * Credentials are supplied by the client implementation and sent along to the server during the
* the server during the authentication process. To provide support for a * authentication process. To provide support for a variety of authentication methods, the
* variety of authentication methods, the credentials class is meant to be * credentials class is meant to be subclassed for the particular method (ie. password, auth
* subclassed for the particular method (ie. password, auth digest, etc.) * digest, etc.) in use in a given system.
* in use in a given system.
* *
* <p> All credentials must provide a username as the username is used to * <p> All credentials must provide a username as the username is used to associate network
* associate network connections with sessions. * connections with sessions.
* *
* <p> All derived classes should provide a no argument constructor so * <p> All derived classes should provide a no argument constructor so that they can be
* that they can be instantiated prior to reconstruction from a data input * instantiated prior to reconstruction from a data input stream.
* stream.
*/ */
public abstract class Credentials implements Streamable public abstract class Credentials implements Streamable
{ {
@@ -49,8 +47,7 @@ public abstract class Credentials implements Streamable
} }
/** /**
* Constructs a blank credentials instance in preparation for * Constructs a blank credentials instance in preparation for unserializing from the network.
* unserializing from the network.
*/ */
public Credentials () public Credentials ()
{ {
@@ -93,8 +90,8 @@ public abstract class Credentials implements Streamable
} }
/** /**
* An easily extensible method via which derived classes can add to * An easily extensible method via which derived classes can add to {@link #toString()}'s
* {@link #toString()}'s output. * output.
*/ */
protected void toString (StringBuilder buf) protected void toString (StringBuilder buf)
{ {