wt.auth
Interface Authenticator

All Known Implementing Classes:
SessionAuthenticator, SimpleAuthenticator

public interface Authenticator

Authenticator interface. Implementation objects are responsible for securly associating method calls to client identity through the use of MethodAuthenticator objects that endorse client calls.

Supported API: true


Field Summary
static String versionID
           
 
Method Summary
 String getUserName(Object auth)
          Get authenticated user name.
 MethodAuthenticator newMethodAuthenticator(String user)
          Create a new MethodAuthenticator object that will associate the given user name to endorsed method calls.
 MethodAuthenticator newMethodAuthenticator(String user, String session_id)
          Create a new MethodAuthenticator object that will associate the given user name to endorsed method calls for an existing session.
 void reauthenticateUser(Object auth)
          Initiate re-authentication for the current session.
 Object setUserName(String user)
          Set authenticated user name.
 

Field Detail

versionID

public static final String versionID
See Also:
Constant Field Values
Method Detail

newMethodAuthenticator

public MethodAuthenticator newMethodAuthenticator(String user)
Create a new MethodAuthenticator object that will associate the given user name to endorsed method calls.

Supported API: true

Parameters:
user - the authenticated user name
Returns:
MethodAuthenticator object

newMethodAuthenticator

public MethodAuthenticator newMethodAuthenticator(String user,
                                                  String session_id)
Create a new MethodAuthenticator object that will associate the given user name to endorsed method calls for an existing session.

Supported API: true

Parameters:
user - the authenticated user name
session_id - string identifying the target session
Returns:
MethodAuthenticator object

getUserName

public String getUserName(Object auth)
Get authenticated user name. This method uses an authentication object added to the method call by a MethodAuthenticator endorsement to determine the authenticated user name.

Supported API: true

Parameters:
auth - authentication object for the current call
Returns:
the authenticated user name

setUserName

public Object setUserName(String user)
Set authenticated user name. This method returns an authentication object that will cause cause getUserName to return the given name.

Supported API: true

Parameters:
user - authenticated user name
Returns:
authentication object for the current call

reauthenticateUser

public void reauthenticateUser(Object auth)
Initiate re-authentication for the current session.

Supported API: true

Parameters:
auth - authentication object for the current call