Uses of Class
com.caplin.server.auth.AuthenticationResult

Packages that use AuthenticationResult

Package	Description
com.caplin.server.auth	Provides the core interfaces and classes that are required to write a Liberator Auth Module.
examples	Some basic examples of Liberator Auth Modules.

Uses of AuthenticationResult in com.caplin.server.auth

Fields in com.caplin.server.auth declared as AuthenticationResult

Modifier and Type	Field and Description
static AuthenticationResult	AuthenticationResult.ACCT_EXPIRED Use to indicate the supplied login credentials are for an expired user account.
static AuthenticationResult	AuthenticationResult.AGAIN Use only when performing content-based permissioning where the content is not yet available.
static AuthenticationResult	AuthenticationResult.DELAYED Use in combination with DelayedResultReceiver.delayedCheckUserResult or DelayedResultReceiver.delayedMapObjectResult when the authentication result is not yet available.
static AuthenticationResult	AuthenticationResult.DENY Use to indicate that authorisation or authentication is denied.
static AuthenticationResult	AuthenticationResult.ERROR Use when an error has occured in the authentication process.
static AuthenticationResult	AuthenticationResult.FALSE Indicates no object name mapping has taken place.
static AuthenticationResult	AuthenticationResult.INVALID_ADDR Use when authentication is denied because the supplied ip address is deemed unacceptable.
static AuthenticationResult	AuthenticationResult.INVALID_PASS Use when the supplied password is not valid and you want this information known to the client.
static AuthenticationResult	AuthenticationResult.INVALID_USER Use when the supplied user name is not valid.
static AuthenticationResult	AuthenticationResult.OK Use to indicate a successful authentication result.
static AuthenticationResult	AuthenticationResult.SITE_LC_EXCEEDED Use to indicate that some global maximum session count has been met/exceeded.
static AuthenticationResult	AuthenticationResult.USER_LC_EXCEEDED Use to indicate the supplied login credentials have exceeded their concurrent maximum allowed login count.
static AuthenticationResult	AuthenticationResult.USER1 Use to indicate a custom authentication result.
static AuthenticationResult	AuthenticationResult.USER2 Use to indicate a custom authentication result.
static AuthenticationResult	AuthenticationResult.USER3 Use to indicate a custom authentication result.
static AuthenticationResult	AuthenticationResult.USER4 Use to indicate a custom authentication result.
static AuthenticationResult	AuthenticationResult.USER5 Use to indicate a custom authentication result.

Methods in com.caplin.server.auth that return AuthenticationResult

Modifier and Type	Method and Description
AuthenticationResult	Authenticator.authoriseHTTP(AuthenticationUser user) This method will be called when an HTTP directory access authorisation is required.
AuthenticationResult	AuthenticatorAdaptor.authoriseHTTP(AuthenticationUser user)
AuthenticationResult	Authenticator.checkPermissionUpdate(UserSession session, RTTPObject object, java.lang.String key, java.util.Map<java.lang.String,java.lang.String> fieldValues) Called on every update to a permission object to allow the Authenticator to authenticate each update based on content.
AuthenticationResult	AuthenticatorAdaptor.checkPermissionUpdate(UserSession session, RTTPObject object, java.lang.String key, java.util.Map<java.lang.String,java.lang.String> fieldValues)
AuthenticationResult	Authenticator.checkRead(UserSession session, RTTPObject object) This method will be called to check authentication every time a user tries to read an object.
AuthenticationResult	AuthenticatorAdaptor.checkRead(UserSession session, RTTPObject object)
AuthenticationResult	SessionManager.checkSignature(java.lang.String keyIdentifier, java.lang.String token) Provides a mechanism for validating a KeyMaster-generated encrypted single-use token.
AuthenticationResult	Authenticator.checkUpdate(UserSession session, RTTPObject object, java.lang.String data) Called on every update to an object (currently only news headline objects) to allow the Authenticator to authenticate each update based on content.
AuthenticationResult	AuthenticatorAdaptor.checkUpdate(UserSession session, RTTPObject object, java.lang.String data)
AuthenticationResult	Authenticator.checkUser(UserSession session) The user login authorisation method which is called every time a user tries to login to the server.
AuthenticationResult	AuthenticatorAdaptor.checkUser(UserSession session)
AuthenticationResult	Authenticator.checkWrite(UserSession session, RTTPObject object, java.lang.String contributionId, java.util.Map<java.lang.String,java.lang.String> fields) This method will be called to check authentication every time a user attempts to create or write to an object.
AuthenticationResult	AuthenticatorAdaptor.checkWrite(UserSession session, RTTPObject object, java.lang.String contributionId, java.util.Map<java.lang.String,java.lang.String> fields)
AuthenticationResult	DataCache.createObject(java.lang.String objectName, int objectType) Creates a new object of the given type in the Libertor's object cache.
AuthenticationResult	Authenticator.discardObject(UserSession session, RTTPObject object) This method will be called when a user's session is no longer subscribed to an object.
AuthenticationResult	AuthenticatorAdaptor.discardObject(UserSession session, RTTPObject object)
AuthenticationResult	Authenticator.mapObject(UserSession session, MapObject mapObject) This method will be called every time a user tries to read an object (before checkRead).
AuthenticationResult	AuthenticatorAdaptor.mapObject(UserSession session, MapObject mapObject)
AuthenticationResult	Authenticator.newObject(RTTPObject object, RTTPObject parent) This method is called when a new object is created in the Liberator.
AuthenticationResult	AuthenticatorAdaptor.newObject(RTTPObject object, RTTPObject parent)
AuthenticationResult	Authenticator.releaseObject(RTTPObject object) This method will be called when the Liberator deletes an object.
AuthenticationResult	AuthenticatorAdaptor.releaseObject(RTTPObject object)
AuthenticationResult	Authenticator.releaseUser(UserSession session) This method will be called when the Liberator deletes the user session due to logout or timeout.
AuthenticationResult	AuthenticatorAdaptor.releaseUser(UserSession session)
AuthenticationResult	Authenticator.requestObject(UserSession session, RTTPObject object) This method will be called when a user's session becomes subscribed to an object.
AuthenticationResult	AuthenticatorAdaptor.requestObject(UserSession session, RTTPObject object)
AuthenticationResult	SessionManager.verifySignatureUsername(java.lang.String username, java.lang.String token) Provides a mechanism for verifying the username embedded within a KeyMaster token.

Methods in com.caplin.server.auth with parameters of type AuthenticationResult

Modifier and Type	Method and Description
void	DelayedResultReceiver.delayedCheckUserResult(UserSession userSession, AuthenticationResult result) This method should be called when providing a delayed result from a Authenticator.checkUser call.
void	DelayedResultReceiver.delayedCheckWriteResult(UserSession userSession, RTTPObject object, java.lang.String contributionId, AuthenticationResult result) Use to provide a delayed result for a Authenticator.checkWrite call.
void	DelayedResultReceiver.delayedMapObjectResult(UserSession userSession, MapObject mappedObject, AuthenticationResult result) Use to provide a delayed result for a Authenticator.mapObject call.

Uses of AuthenticationResult in examples

Methods in examples that return AuthenticationResult

Modifier and Type	Method and Description
AuthenticationResult	OpenAuthenticator.authoriseHTTP(AuthenticationUser user)
AuthenticationResult	PermissionAuthenticator.authoriseHTTP(AuthenticationUser user)
AuthenticationResult	TieringAuthenticator.authoriseHTTP(AuthenticationUser user)
AuthenticationResult	OpenAuthenticator.checkPermissionUpdate(UserSession session, RTTPObject object, java.lang.String key, java.util.Map<java.lang.String,java.lang.String> fieldValues)
AuthenticationResult	PermissionAuthenticator.checkPermissionUpdate(UserSession session, RTTPObject object, java.lang.String key, java.util.Map<java.lang.String,java.lang.String> fieldValues)
AuthenticationResult	TieringAuthenticator.checkPermissionUpdate(UserSession session, RTTPObject object, java.lang.String key, java.util.Map<java.lang.String,java.lang.String> fieldValues)
AuthenticationResult	OpenAuthenticator.checkRead(UserSession session, RTTPObject object)
AuthenticationResult	PermissionAuthenticator.checkRead(UserSession session, RTTPObject object)
AuthenticationResult	TieringAuthenticator.checkRead(UserSession session, RTTPObject object)
AuthenticationResult	OpenAuthenticator.checkUpdate(UserSession session, RTTPObject object, java.lang.String data)
AuthenticationResult	PermissionAuthenticator.checkUpdate(UserSession session, RTTPObject object, java.lang.String data)
AuthenticationResult	TieringAuthenticator.checkUpdate(UserSession session, RTTPObject object, java.lang.String data)
AuthenticationResult	DelayedLoginAuthenticator.checkUser(UserSession session)
AuthenticationResult	OpenAuthenticator.checkUser(UserSession session)
AuthenticationResult	PermissionAuthenticator.checkUser(UserSession session)
AuthenticationResult	TieringAuthenticator.checkUser(UserSession session)
AuthenticationResult	KeyMasterAuthenticator.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
AuthenticationResult	OpenAuthenticator.checkWrite(UserSession session, RTTPObject object, java.lang.String contributionId, java.util.Map<java.lang.String,java.lang.String> fields)
AuthenticationResult	PermissionAuthenticator.checkWrite(UserSession session, RTTPObject object, java.lang.String contributionId, java.util.Map<java.lang.String,java.lang.String> fields)
AuthenticationResult	TieringAuthenticator.checkWrite(UserSession session, RTTPObject object, java.lang.String contributionId, java.util.Map<java.lang.String,java.lang.String> fields)
AuthenticationResult	OpenAuthenticator.discardObject(UserSession session, RTTPObject object)
AuthenticationResult	PermissionAuthenticator.discardObject(UserSession session, RTTPObject object)
AuthenticationResult	TieringAuthenticator.discardObject(UserSession session, RTTPObject object)
AuthenticationResult	OpenAuthenticator.mapObject(UserSession session, MapObject mapObject)
AuthenticationResult	PermissionAuthenticator.mapObject(UserSession session, MapObject mapObject)
AuthenticationResult	TieringAuthenticator.mapObject(UserSession session, MapObject mapObject)
AuthenticationResult	OpenAuthenticator.newObject(RTTPObject object, RTTPObject parent)
AuthenticationResult	PermissionAuthenticator.newObject(RTTPObject object, RTTPObject parent)
AuthenticationResult	TieringAuthenticator.newObject(RTTPObject object, RTTPObject parent)
AuthenticationResult	OpenAuthenticator.releaseObject(RTTPObject object)
AuthenticationResult	PermissionAuthenticator.releaseObject(RTTPObject object)
AuthenticationResult	TieringAuthenticator.releaseObject(RTTPObject object)
AuthenticationResult	OpenAuthenticator.releaseUser(UserSession session)
AuthenticationResult	PermissionAuthenticator.releaseUser(UserSession session)
AuthenticationResult	TieringAuthenticator.releaseUser(UserSession session)
AuthenticationResult	OpenAuthenticator.requestObject(UserSession session, RTTPObject object)
AuthenticationResult	PermissionAuthenticator.requestObject(UserSession session, RTTPObject object)
AuthenticationResult	TieringAuthenticator.requestObject(UserSession session, RTTPObject object)