Package com.caplin.server.auth

Class AuthenticationUser

  • public class AuthenticationUser
extends java.lang.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 Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getPassword()
      The textual key string or password that has been provided by the client for authorisation.
      int getSessionCount()
      Get the number of active sessions in the Liberator for this user
      java.lang.String getToboUser()
      Get the TOBO username
      java.lang.String getTokenParameter​(java.lang.String paramName)
      Get fields from a KeyMaster token
      java.lang.String getUserName()
      The user name provided by the client for authorisation
      void resetToboUser()
      Clear the TOBO username for this user
      void setToboUser​(java.lang.String toboUser)
      Set the TOBO username
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getPassword

        public java.lang.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 java.lang.String getUserName()
        The user name provided by the client for authorisation
        Returns:
        the user name provided for authorisation

      • setToboUser

        public void setToboUser​(java.lang.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 java.lang.String getToboUser()
        Get the TOBO username
        Returns:
        The TOBO username (or null if not defined)

      • getTokenParameter

        public java.lang.String getTokenParameter​(java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object