Package com.caplin.server.auth

Provides the core interfaces and classes that are required to write a Liberator Auth Module.

See: Description

Interface Summary

Interface	Description
Authenticator	Defines the interface to be implemented by a Liberator Auth Module.
DataCache
DelayedResultReceiver	Provides an interface that allows delayed authentication results to be passed to the Liberator.
ServerNode	Contains information about the server and its sessions.
SessionManager	Provides an interface to allow management (ejection and invalidation) of connected sessions and checking of KeyMaster tokens.
Subscription	Allows subscriptions from SessionManager to be initiated and unsubscribed from.
SubscriptionListener	Callbacks for SessionManager.

Class Summary

Class	Description
AuthenticationResult	Static instances of this class are used to provide various authentication results to the Liberator.
AuthenticationUser	Represents a user that is connected to the Liberator and attempting to be authenticated.
AuthenticatorAdaptor	A default implementation of the Authenticator interface.
AuthenticatorVersion
ErrorLoggingAuthenticatorProxy
InvalidationType	Instances of this class are used to indicate the type of user invalidation that the Liberator should perform.
MapObject	Contains a representation of a mapped RTTP object holding the original object name and its mapped name.
RTTPObject	A representation of an RTTP Object that is present in the Liberator.
SubscriptionImpl	Allows subscriptions from SessionManager to initiated and unsubscribed from.
UserSession	Represents a user's session on the liberator

Enum Summary

Enum	Description
PermissionUpdateType	Enum defining the type of update passed to the authenticator permission methods (checkPermissionUpdate() and globalPermissionUpdate).

Package com.caplin.server.auth Description

Provides the core interfaces and classes that are required to write a Liberator Auth Module. The most important of these is Authenticator, which is the interface that must be implemented by a class that wants to operate as a Liberator Auth Module.

The AuthenticatorAdaptor provides a default implementation of the Authenticator interface. It may be used as-is for basic open authentication or extended for simple authentication schemes.

Implementations of all of the following interfaces are passed in to the Authenticator's intitialise method. They can then be used at a later time to perform functions or access information from the server.

The SessionManager interface allows an Authenticator to manage connected sessions. Sessions may be ejected or invalidated by a number of criteria such as machine ID and application ID. Invalidation of a session forces the Liberator to re-check all (or a subset, depending on the InvalidationType specified) permissions for that session. An individual object may also be invalidated forcing Liberator to re-check all permissions for that object on all sessions.

The ServerNode interface provides access to information about the server and session counts.

The DelayedResultReceiver interface is used to return authentication results asynchronously. This is of particular use when the authentication mechanism relies on an external or remote service that may take some time providing information required to make an authentication decision. By utilising this mechanism potential performance issues that synchronous (blocking) calls can introduce are avoided.

Other classes such as AuthenticationUser, UserSession, MapObject and RTTPObject provide representations of their respective objects within the Liberator server.