examples

Class KeyMasterAuthenticator

java.lang.Object

examples.OpenAuthenticator

examples.KeyMasterAuthenticator

All Implemented Interfaces:

Authenticator

public class KeyMasterAuthenticator
extends OpenAuthenticator

An example Authenticator that shows how to check KeyMaster tokens in a Liberator Auth Module.

Constructor Summary

Constructors

Constructor and Description
KeyMasterAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationResult	checkUser(UserSession session) If the user is in our list of KeyMaster users then check the password is a valid token, otherwise delegate to the superclass
void	initialise(SessionManager sessionManager, DelayedResultReceiver delayedResultReceiver, ServerNode serverNode, java.lang.String loggerName) Store the sessionManager for use when checking tokens

Methods inherited from class examples.OpenAuthenticator

authoriseHTTP, checkPermissionUpdate, checkRead, checkUpdate, checkWrite, discardObject, globalPermissionUpdate, mapObject, newObject, releaseObject, releaseUser, requestObject, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyMasterAuthenticator

public KeyMasterAuthenticator()

Method Detail

initialise

public void initialise(SessionManager sessionManager,
              DelayedResultReceiver delayedResultReceiver,
              ServerNode serverNode,
              java.lang.String loggerName)

Store the sessionManager for use when checking tokens

Specified by:

initialise in interface Authenticator

Overrides:

initialise in class OpenAuthenticator

Parameters:

sessionManager - a SessionManager instance that can be used for invalidating and ejecting user sessions in the Liberator.

delayedResultReceiver - a DelayedResultReceiver instance that can be used for sending delayed authentication results after an AuthenticationResult.DELAYED is used.

serverNode - a ServerNode instance that provides access to information about the server and its session count.

loggerName - the name of the logger that provides native logging output to the Liberator's auth log file (by default auth-rttpd.log).

checkUser

public AuthenticationResult checkUser(UserSession session)

If the user is in our list of KeyMaster users then check the password is a valid token, otherwise delegate to the superclass

Specified by:

checkUser in interface Authenticator

Overrides:

checkUser in class OpenAuthenticator

Parameters:

session - the UserSession object containing information about the user and their login details.

Returns:

an AuthenticationResult instance - usually AuthenticationResult.OK , AuthenticationResult.DENY or one of the specific failure results such as AuthenticationResult.INVALID_USER.

See Also:

OpenAuthenticator.checkUser(com.caplin.server.auth.UserSession)