Uses of Class
com.caplin.server.auth.AuthenticationResult
Packages that use AuthenticationResult
-
Uses of AuthenticationResult in com.caplin.server.auth
Fields in com.caplin.server.auth declared as AuthenticationResultModifier and TypeFieldDescriptionstatic final AuthenticationResult
AuthenticationResult.ACCT_EXPIRED
Use to indicate the supplied login credentials are for an expired user account.static final AuthenticationResult
AuthenticationResult.AGAIN
Use only when performing content-based permissioning where the content is not yet available.static final AuthenticationResult
AuthenticationResult.DELAYED
Use in combination withDelayedResultReceiver.delayedCheckUserResult
orDelayedResultReceiver.delayedMapObjectResult
when the authentication result is not yet available.static final AuthenticationResult
AuthenticationResult.DENY
Use to indicate that authorisation or authentication is denied.static final AuthenticationResult
AuthenticationResult.ERROR
Use when an error has occured in the authentication process.static final AuthenticationResult
AuthenticationResult.FALSE
Indicates no object name mapping has taken place.static final AuthenticationResult
AuthenticationResult.INVALID_ADDR
Use when authentication is denied because the supplied ip address is deemed unacceptable.static final AuthenticationResult
AuthenticationResult.INVALID_PASS
Use when the supplied password is not valid and you want this information known to the client.static final AuthenticationResult
AuthenticationResult.INVALID_USER
Use when the supplied user name is not valid.static final AuthenticationResult
AuthenticationResult.OK
Use to indicate a successful authentication result.static final AuthenticationResult
AuthenticationResult.SITE_LC_EXCEEDED
Use to indicate that some global maximum session count has been met/exceeded.static final AuthenticationResult
AuthenticationResult.USER_LC_EXCEEDED
Use to indicate the supplied login credentials have exceeded their concurrent maximum allowed login count.static final AuthenticationResult
AuthenticationResult.USER1
Use to indicate a custom authentication result.static final AuthenticationResult
AuthenticationResult.USER2
Use to indicate a custom authentication result.static final AuthenticationResult
AuthenticationResult.USER3
Use to indicate a custom authentication result.static final AuthenticationResult
AuthenticationResult.USER4
Use to indicate a custom authentication result.static final AuthenticationResult
AuthenticationResult.USER5
Use to indicate a custom authentication result.Methods in com.caplin.server.auth that return AuthenticationResultModifier and TypeMethodDescriptionAuthenticator.authoriseHTTP
(AuthenticationUser user) This method will be called when an HTTP directory access authorisation is required.AuthenticatorAdaptor.authoriseHTTP
(AuthenticationUser user) Authenticator.checkPermissionUpdate
(UserSession session, RTTPObject object, String key, Map<String, String> fieldValues) Called on every update to a permission object to allow the Authenticator to authenticate each update based on content.AuthenticatorAdaptor.checkPermissionUpdate
(UserSession session, RTTPObject object, String key, Map<String, String> fieldValues) Authenticator.checkRead
(UserSession session, RTTPObject object, String requestedName) This method will be called to check authentication every time a user tries to read an object.AuthenticatorAdaptor.checkRead
(UserSession session, RTTPObject object, String requestedName) SessionManager.checkSignature
(String keyIdentifier, String token) Provides a mechanism for validating a KeyMaster-generated encrypted single-use token.Authenticator.checkUpdate
(UserSession session, RTTPObject object, 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.AuthenticatorAdaptor.checkUpdate
(UserSession session, RTTPObject object, String data) Authenticator.checkUser
(UserSession session) The user login authorisation method which is called every time a user tries to login to the server.AuthenticatorAdaptor.checkUser
(UserSession session) Authenticator.checkWrite
(UserSession session, RTTPObject object, String requestedName, String contributionId, Map<String, String> fields) This method will be called to check authentication every time a user attempts to create or write to an object.AuthenticatorAdaptor.checkWrite
(UserSession session, RTTPObject object, String requestedName, String contributionId, Map<String, String> fields) DataCache.createObject
(String objectName, int objectType) Creates a new object of the given type in the Libertor's object cache.Authenticator.discardObject
(UserSession session, RTTPObject object) This method will be called when a user's session is no longer subscribed to an object.AuthenticatorAdaptor.discardObject
(UserSession session, RTTPObject object) Authenticator.mapObject
(UserSession session, MapObject mapObject) This method will be called every time a user tries to read an object (before checkRead).AuthenticatorAdaptor.mapObject
(UserSession session, MapObject mapObject) Authenticator.newObject
(RTTPObject object, RTTPObject parent) This method is called when a new object is created in the Liberator.AuthenticatorAdaptor.newObject
(RTTPObject object, RTTPObject parent) Authenticator.releaseObject
(RTTPObject object) This method will be called when the Liberator deletes an object.AuthenticatorAdaptor.releaseObject
(RTTPObject object) Authenticator.releaseUser
(UserSession session) This method will be called when the Liberator deletes the user session due to logout or timeout.AuthenticatorAdaptor.releaseUser
(UserSession session) Authenticator.requestObject
(UserSession session, RTTPObject object) This method will be called when a user's session becomes subscribed to an object.AuthenticatorAdaptor.requestObject
(UserSession session, RTTPObject object) SessionManager.verifySignatureUsername
(String username, String token) Provides a mechanism for verifying the username embedded within a KeyMaster token.Methods in com.caplin.server.auth with parameters of type AuthenticationResultModifier and TypeMethodDescriptionvoid
DelayedResultReceiver.delayedCheckUserResult
(UserSession userSession, AuthenticationResult result) This method should be called when providing a delayed result from aAuthenticator.checkUser
call.void
DelayedResultReceiver.delayedCheckWriteResult
(UserSession userSession, RTTPObject object, String contributionId, AuthenticationResult result) Use to provide a delayed result for aAuthenticator.checkWrite
call.void
DelayedResultReceiver.delayedMapObjectResult
(UserSession userSession, MapObject mappedObject, AuthenticationResult result) Use to provide a delayed result for aAuthenticator.mapObject
call. -
Uses of AuthenticationResult in examples
Methods in examples that return AuthenticationResultModifier and TypeMethodDescriptionOpenAuthenticator.authoriseHTTP
(AuthenticationUser user) PermissionAuthenticator.authoriseHTTP
(AuthenticationUser user) TieringAuthenticator.authoriseHTTP
(AuthenticationUser user) OpenAuthenticator.checkPermissionUpdate
(UserSession session, RTTPObject object, String key, Map<String, String> fieldValues) PermissionAuthenticator.checkPermissionUpdate
(UserSession session, RTTPObject object, String key, Map<String, String> fieldValues) TieringAuthenticator.checkPermissionUpdate
(UserSession session, RTTPObject object, String key, Map<String, String> fieldValues) OpenAuthenticator.checkRead
(UserSession session, RTTPObject object, String requestedName) PermissionAuthenticator.checkRead
(UserSession session, RTTPObject object, String requestedName) TieringAuthenticator.checkRead
(UserSession session, RTTPObject object, String requestedName) OpenAuthenticator.checkUpdate
(UserSession session, RTTPObject object, String data) PermissionAuthenticator.checkUpdate
(UserSession session, RTTPObject object, String data) TieringAuthenticator.checkUpdate
(UserSession session, RTTPObject object, String data) DelayedLoginAuthenticator.checkUser
(UserSession session) 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 superclassOpenAuthenticator.checkUser
(UserSession session) PermissionAuthenticator.checkUser
(UserSession session) TieringAuthenticator.checkUser
(UserSession session) OpenAuthenticator.checkWrite
(UserSession session, RTTPObject object, String requestedName, String contributionId, Map<String, String> fields) PermissionAuthenticator.checkWrite
(UserSession session, RTTPObject object, String requestedName, String contributionId, Map<String, String> fields) TieringAuthenticator.checkWrite
(UserSession session, RTTPObject object, String requestedName, String contributionId, Map<String, String> fields) OpenAuthenticator.discardObject
(UserSession session, RTTPObject object) PermissionAuthenticator.discardObject
(UserSession session, RTTPObject object) TieringAuthenticator.discardObject
(UserSession session, RTTPObject object) OpenAuthenticator.mapObject
(UserSession session, MapObject mapObject) PermissionAuthenticator.mapObject
(UserSession session, MapObject mapObject) TieringAuthenticator.mapObject
(UserSession session, MapObject mapObject) OpenAuthenticator.newObject
(RTTPObject object, RTTPObject parent) PermissionAuthenticator.newObject
(RTTPObject object, RTTPObject parent) TieringAuthenticator.newObject
(RTTPObject object, RTTPObject parent) OpenAuthenticator.releaseObject
(RTTPObject object) PermissionAuthenticator.releaseObject
(RTTPObject object) TieringAuthenticator.releaseObject
(RTTPObject object) OpenAuthenticator.releaseUser
(UserSession session) PermissionAuthenticator.releaseUser
(UserSession session) TieringAuthenticator.releaseUser
(UserSession session) OpenAuthenticator.requestObject
(UserSession session, RTTPObject object) PermissionAuthenticator.requestObject
(UserSession session, RTTPObject object) TieringAuthenticator.requestObject
(UserSession session, RTTPObject object)