com.threerings.presents.net

Class AuthResponse

java.lang.Object

com.threerings.io.SimpleStreamableObject

com.threerings.presents.net.Message

com.threerings.presents.net.DownstreamMessage

com.threerings.presents.net.AuthResponse

All Implemented Interfaces:

Streamable

Direct Known Subclasses:

SecureResponse

public class AuthResponse
extends DownstreamMessage

The auth response communicates authentication success or failure as well as associated information via a distribted object transmitted along with the response. The distributed object simply serves as a container for the varied and manifold data involved in the authentication process.

Nested Class Summary

Nested classes/interfaces inherited from interface com.threerings.io.Streamable

Streamable.Closure

Field Summary

Fields

Modifier and Type	Field and Description
Object	authdata Auxilliary authentication data to be communicated to the PresentsSession once a session is started.

Fields inherited from class com.threerings.presents.net.DownstreamMessage

messageId

Fields inherited from class com.threerings.presents.net.Message

received

Constructor Summary

Constructors

Constructor and Description
AuthResponse() Zero argument constructor used when unserializing an instance.
AuthResponse(AuthResponseData data) Constructs a auth response with the supplied response data.

Method Summary

Modifier and Type	Method and Description
AuthResponseData	getData()
void	setData(AuthResponseData data) Replaces this response's auth data.
String	toString()

Methods inherited from class com.threerings.presents.net.Message

getTransport, noteActualTransport, setTransport

Methods inherited from class java.lang.Object

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

Field Detail

authdata

public transient Object authdata

Auxilliary authentication data to be communicated to the PresentsSession once a session is started. This is a means by which the Authenticator can pass information loaded from, say, an authentication database into the runtime system to be used, for example for permissions.

Constructor Detail

AuthResponse

public AuthResponse()

Zero argument constructor used when unserializing an instance.

AuthResponse

public AuthResponse(AuthResponseData data)

Constructs a auth response with the supplied response data.

Method Detail

getData

public AuthResponseData getData()

setData

public void setData(AuthResponseData data)

Replaces this response's auth data.

toString

public String toString()

Overrides:

toString in class DownstreamMessage