com.sun.media.jsdt
Class AuthenticationInfo

java.lang.Object
  |
  +--com.sun.media.jsdt.impl.JSDTObject
        |
        +--com.sun.media.jsdt.AuthenticationInfo

public class AuthenticationInfo
extends com.sun.media.jsdt.impl.JSDTObject
implements com.sun.media.jsdt.impl.JSDTDebugFlags

JSDT Authentication Information class.

This class contains all the information needed by a Client to determine what they are being asked to authenticate.

If a JSDT Manageable object (ByteArray, Channel, Session or Token) has a Manager attached to it, any Client that tries to join() that object will be authenticated, and asked to provide a response. If a Client is joined to a managed Session, and wishes to create or destroy a ByteArray, Channel or Token, the same authentication process takes place.

Since:
JSDT 1.0
Version:
1.5 - 7th January 1999
Author:
Rich Burridge
See Also:
Serialized Form

Field Summary
static char BYTEARRAY
          The ByteArray authentication type.
static char CHANNEL
          The Channel authentication type.
static int CREATE_BYTEARRAY
          The create ByteArray authentication action.
static int CREATE_CHANNEL
          The create Channel authentication action.
static int CREATE_TOKEN
          The create Token authentication action.
static int DESTROY_BYTEARRAY
          The destroy ByteArray authentication action.
static int DESTROY_CHANNEL
          The destroy Channel authentication action.
static int DESTROY_SESSION
          The join authentication action.
static int DESTROY_TOKEN
          The destroy Token authentication action.
static int JOIN
          The join authentication action.
static char SESSION
          The Session authentication type.
static char TOKEN
          The Token authentication type.
 
Fields inherited from class com.sun.media.jsdt.impl.JSDTObject
giveTime, httpTunnelPort, maxQueueSize, maxThreadPoolSize, pingPeriod, registryAddress, registryPort, registryTime, showMessage, showStack, socketFactoryClass, SSLCipher, timeoutPeriod, TTL, versionString
 
Constructor Summary
AuthenticationInfo(Session session, int action, java.lang.String name, char type)
           the constructor for the AuthenticationInfo class.
 
Method Summary
 int getAction()
           get the authentication action (CREATE, DESTROY or JOIN).
 java.lang.Object getChallenge()
           get the challenge given by the manager.
 java.lang.String getName()
           Get the name of the object associated with this authentication operation.
 Session getSession()
           get the Session associated with this authentication operation.
 char getType()
           get the type of this manageable object (ByteArray, Channel, Session or Token).
 void setChallenge(java.lang.Object challenge)
           set the challenge for this authentication.
 java.lang.String toString()
           toString print a short description of this ByteArray event.
 
Methods inherited from class com.sun.media.jsdt.impl.JSDTObject
error, getConnectionType, setConnectionType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BYTEARRAY

public static final char BYTEARRAY
The ByteArray authentication type.

CHANNEL

public static final char CHANNEL
The Channel authentication type.

SESSION

public static final char SESSION
The Session authentication type.

TOKEN

public static final char TOKEN
The Token authentication type.

CREATE_BYTEARRAY

public static final int CREATE_BYTEARRAY
The create ByteArray authentication action.

DESTROY_BYTEARRAY

public static final int DESTROY_BYTEARRAY
The destroy ByteArray authentication action.

CREATE_CHANNEL

public static final int CREATE_CHANNEL
The create Channel authentication action.

DESTROY_CHANNEL

public static final int DESTROY_CHANNEL
The destroy Channel authentication action.

CREATE_TOKEN

public static final int CREATE_TOKEN
The create Token authentication action.

DESTROY_TOKEN

public static final int DESTROY_TOKEN
The destroy Token authentication action.

JOIN

public static final int JOIN
The join authentication action.

DESTROY_SESSION

public static final int DESTROY_SESSION
The join authentication action.
Constructor Detail

AuthenticationInfo

public AuthenticationInfo(Session session,
                          int action,
                          java.lang.String name,
                          char type)
the constructor for the AuthenticationInfo class. A new authentication info object is generated every time a Client tries to perform a priviledged action on a managed object.
Parameters:
session - the Session associated with this authentication operation.
action - the authentication action.
name - the name of the manageable object.
type - the type of the manageable object.
Method Detail

getAction

public int getAction()
get the authentication action (CREATE, DESTROY or JOIN).
Returns:
the authentication action.

getChallenge

public java.lang.Object getChallenge()
get the challenge given by the manager.
Returns:
the challenge given by the manager.

getName

public java.lang.String getName()
Get the name of the object associated with this authentication operation. This will be the name of the ByteArray, Channel or Token being created, or the name of the ByteArray, Channel, Session or Token being destroyed, or the name of the manageable object the Client is trying to join.
Returns:
the name of the object associated with this authentication operation.

getSession

public Session getSession()
get the Session associated with this authentication operation.
Returns:
the Session associated with this authentication operation.
Since:
JSDT 1.2

getType

public char getType()
get the type of this manageable object (ByteArray, Channel, Session or Token).
Returns:
the type of this manageable object.

setChallenge

public void setChallenge(java.lang.Object challenge)
set the challenge for this authentication. This is an operation that is performed by the manager just before it passes the authentication information onto the client.
Parameters:
challenge - the challenge. This object needs to be serializable.

toString

public java.lang.String toString()
toString print a short description of this ByteArray event.
Returns:
a String containing a description of this ByteArray event.
Overrides:
toString in class java.lang.Object
Since:
JSDT 1.3