Package de.elo.ix.client

Interface IXAuthenticationIF

All Superinterfaces:
byps.BAuthentication
All Known Implementing Classes:
IXAuthentication, IXAuthenticationNormalized, IXAuthenticationWrapper
public interface IXAuthenticationIF extends byps.BAuthentication
Interface used as abstraction for authentication logic.

  • Field Details

  • Method Details

    • getLoginResult

      LoginResult getLoginResult()
      LoginResult received from Indexserver as the result of authentication.
      Returns:
      LoginResult

    • getClientInfo

      ClientInfo getClientInfo()
      This object is implicitly passed to each Indexserver request and contains the authentication ticket.
      Returns:
      ClientInfo

    • makeSessOptsObj

      SessionOptions makeSessOptsObj()
      Build SessionOptions object from current session options.
      Returns:
      SessionOptions

    • fromSessOptsObj

      void fromSessOptsObj(SessionOptions opts)
      Store provided SessionOptions object in current session options. This function does not send the options to IX.
      Parameters:
      opts - SessionOptions object.

    • addListener

      void addListener(IXAuthenticationListener listener)
      Add a listener that is called on re-login.
      Parameters:
      listener - Callback object

    • removeListener

      void removeListener(IXAuthenticationListener listener)
      Remove a listener that was previously set by addListener(IXAuthenticationListener).
      Parameters:
      listener - Callback object

    • isExpired

      boolean isExpired()
      Check whether the current session ClientInfo.ticket is expired.
      Returns:
      true if expired

    • needAlive

      boolean needAlive()
      Check whether the current session ClientInfo.ticket needs to be renewed.
      Returns:
      true if renew is required

    • getSessionOptions

      Properties getSessionOptions()
      Return session options.
      Returns:
      Session options

    • encryptPassword

      String encryptPassword(String text) throws byps.RemoteException
      Encrypt the given text before sending over the wire.
      Parameters:
      text - Plain text to be encrypted
      Returns:
      Encrypted text
      Throws:
      byps.RemoteException

    • getDatabaseEngine

      String getDatabaseEngine()
      Get database engine name. This value is received by a call to IXServicePortIF.getServerInfo(ClientInfo) and corresponds to ServerInfo.databaseEngine.
      Returns:
      Database engine

    • getEncryptionPasswords

      Properties getEncryptionPasswords()
      Reserved.
      Returns:

    • getAuthenticationType

      EAuthenticationType getAuthenticationType()
      Type of this authentication object.
      Returns:
      Authentication type

    • setLoginResult

      void setLoginResult(LoginResult loginResult)
      Called after authentication to pass the LoginResult.
      Parameters:
      loginResult - Authentication result

    • getVersion

      String getVersion()
      Return IX version.
      Returns:
      IX version. EIX-2519

    • getServerTime

      Date getServerTime()
      Server time. EIX-2519
      Returns:
      Server time

    • getInstanceName

      String getInstanceName()
      Return IXID defined in Indexserver options.
      Returns:
      Instance name