IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.objectgrid.security.plugins.builtins
Class WSTokenAuthenticator

java.lang.Object
  extended by com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenAuthenticator
All Implemented Interfaces:
Authenticator

public class WSTokenAuthenticator
extends Object
implements Authenticator

This class represents a Authenticator when both ObjectGrid clients and ObjectGrid servers are launched in the WebSphere application server JVMs, and these application servers are in the same security domain.

When both ObjectGrid clients and servers run in WebSphere application servers, the client can use the WSTokenCredentialGenerator class to generate a credential and ask the server to use this Authenticator implementation class to validate the WSTokenCredential. If the token is validated successfully, a Subject is returned.

This scenario takes advantage of the fact that an ObjectGrid client has already been authenticated. Since the application servers housing the ObjectGrid servers are in the same security domain as the application servers housing the ObjectGrid client, the security tokens can be propagated from the ObjectGrid client to the ObjectGrid server so there is no need to re-authenticate to the same user registry. This authenticator returns a Subject with a Principal of class com.ibm.websphere.security.auth.WSPrincipal.

Since:
WAS XD 6.0.1
See Also:
Authenticator, WSTokenCredential, WSTokenCredentialGenerator

Constructor Summary
WSTokenAuthenticator()
           
 
Method Summary
 Subject authenticate(Credential credential)
          Authenticates the WSTokenCredential and returns a Subject object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSTokenAuthenticator

public WSTokenAuthenticator()
Method Detail

authenticate

public Subject authenticate(Credential credential)
                     throws InvalidCredentialException,
                            ExpiredCredentialException
Authenticates the WSTokenCredential and returns a Subject object.

The credential is expected to be a WSTokenCredential type.

Specified by:
authenticate in interface Authenticator
Parameters:
credential - the user Credential
Returns:
a Subject object representing the user
Throws:
InvalidCredentialException - if credential isn't a WSTokenCredential or some error occurs during processing of the supplied WSTokenCredential
ExpiredCredentialException - if credential is expired. This exception is not used by this implementation
See Also:
Authenticator.authenticate(Credential), WSTokenCredential

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.