Package com.caplin.server.auth

Class AuthenticationUser

java.lang.Object
com.caplin.server.auth.AuthenticationUser
public class AuthenticationUser extends Object

Represents a user that is connected to the Liberator and attempting to be authenticated.

An instance of an AuthenticationUser is held by a UserSession object that is passed to one of the Authenticator interface methods.

An AuthenticationUser instance is also passed directly to Authenticator.authoriseHTTP(com.caplin.server.auth.AuthenticationUser) as this is a one-off operation that doesn't have a session associated with it.

  • Method Details

    • getPassword

      public String getPassword()
      The textual key string or password that has been provided by the client for authorisation.
      Returns:
      the password provided for authorisation

    • getUserName

      public String getUserName()
      The user name provided by the client for authorisation
      Returns:
      the user name provided for authorisation

    • setToboUser

      public void setToboUser(String toboUser)
      Set the TOBO username
      Parameters:
      toboUser - The TOBO username The tobouser can be referenced via %t in static object-map configuration directives

    • resetToboUser

      public void resetToboUser()
      Clear the TOBO username for this user

    • getToboUser

      public String getToboUser()
      Get the TOBO username
      Returns:
      The TOBO username (or null if not defined)

    • getTokenParameter

      public String getTokenParameter(String paramName)
      Get fields from a KeyMaster token
      Parameters:
      paramName - The name of the parameter whose associated value is to be returned
      Returns:
      The associated value or null

    • getSessionCount

      public int getSessionCount()
      Get the number of active sessions in the Liberator for this user
      Returns:
      the number of active sessions

    • toString

      public String toString()
      Overrides:
      toString in class Object