Package de.elo.ix.client

Interface IXClientIF

All Known Implementing Classes:
IXClient
@Deprecated public interface IXClientIF
Deprecated.

  • Method Details

    • init

      void init(String endpoint, String endpointSSL, int maxConnections, int timeoutSeconds) throws byps.RemoteException
      Deprecated.
      Initialize the connection to the Indexserver. Call this function, if the object was initialized by the default constructor.
      Parameters:
      endpoint - Indexserver URL
      endpointSSL - Reserved, must be null
      maxConnections - Maximum of HTTP connections to Indexserver. This should be 2 for client applications, that use only one thread. Server applications with more threads should increase this number to the number of threads + 1.
      timeoutSeconds - A timeout exception is thrown, if a call to Indexserver needs more time than this number of seconds.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • setSecure

      @Deprecated boolean setSecure(boolean sec)
      Deprecated.
      Returns always true now.
      Selects the secure endpoint URL supplied in the constructor. Because SSL connections cause only a negliable overhead, this function is deprecated. SSL connections should be used for all calls.
      Parameters:
      sec - true, if secure endpoint should be addressed.
      Returns:
      true, if the secure endpoint URL has been used previsiously.

    • getCONST

      IXServicePortC getCONST(ClientInfo ci) throws byps.RemoteException
      Deprecated.
      Retuns the Indexserver constants
      Parameters:
      ci - ClientInfo object
      Returns:
      Constants object including all Indexserver constants.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • login

      LoginResult login(ClientInfo ci, String userName, String userPwd, String computerName, String runAs) throws byps.RemoteException
      Deprecated.
      Log on to Indexserver and start a background thread that refreshes the ticket periodically.
      Parameters:
      ci - ClientInfo object
      userName - User name to log in
      userPwd - User password
      computerName - Computer name
      runAs - User name that specifies the security context. If null, userName defines the security context.
      Returns:
      LoginResult object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • loginAdmin

      LoginResult loginAdmin(ClientInfo ci, String userName, String userPwd, String computerName, String reportAs) throws byps.RemoteException
      Deprecated.
      Log on to Indexserver and start a background thread that refreshes the ticket periodically.
      Parameters:
      ci - ClientInfo object
      userName - User name to log in
      userPwd - User password
      computerName - Computer name
      reportAs - User name or ID used in reporting and as owner ID. userName defines the security context.
      Returns:
      LoginResult object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • loginKerberos

      LoginResult loginKerberos(ClientInfo ci, byte[] ticket, String computerName) throws byps.RemoteException
      Deprecated.
      Kerberos Login
      Parameters:
      ci - ClientInfo object
      ticket - The KRB_AP_REQ Message as defined in RFC 1510
      computerName - Client computer name for reporting.
      Returns:
      LoginResult
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • loginKerberos

      LoginResult loginKerberos(String realm, String kdc, String servicePrincipal, String computerName) throws byps.RemoteException, GSSException, FileNotFoundException
      Deprecated.
      Parameters:
      realm - Kerberos Realm, Windows Domain, e.g. ELO.local
      kdc - Key Distribution Center, Active Directory computer name, e.g. negril.elo.local
      servicePrincipal - Account name used to generate the keytab file for AM, e.g. krb_NEGRIL
      computerName - Client computer name for reporting.
      Returns:
      LoginResult object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".
      GSSException - Error occurs inside Kerberos library.
      FileNotFoundException - Error occurs while accessing Kerberos configuration files.

    • loginKerberos

      LoginResult loginKerberos(ClientInfo ci, String realm, String kdc, String servicePrincipal, String computerName, boolean addToAliveThread) throws byps.RemoteException, GSSException, FileNotFoundException
      Deprecated.
      Throws:
      byps.RemoteException
      GSSException
      FileNotFoundException

    • logout

      void logout(ClientInfo ci) throws byps.RemoteException
      Deprecated.
      Log out and stop automatic ticket refreshing.
      Parameters:
      ci - ClientInfo object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • done

      void done()
      Deprecated.
      Logout all active sessions and stop internal thread for ticket refreshing.

    • getVersion

      String getVersion() throws byps.RemoteException
      Deprecated.
      Detect Indexserver version without build number.
      Returns:
      IX-Version
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • getImplVersion

      String getImplVersion() throws byps.RemoteException
      Deprecated.
      Detect Indexserver version with build number.
      Returns:
      IX-Version
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • getInterfaceVersion

      String getInterfaceVersion() throws byps.RemoteException
      Deprecated.
      Detect Indexserver interface version.
      Returns:
      IX interface version
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • getServerTime

      Date getServerTime() throws byps.RemoteException
      Deprecated.
      Gets the current server time.
      Returns:
      Server time.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • getClientVersion

      String getClientVersion()
      Deprecated.
      Returns the version of the IXClient class, resp. the latest binary protocol version the IXClient class can understand.
      Returns:
      latest protocol version
      See Also:

    • getStreamVersion

      String getStreamVersion()
      Deprecated.
      Returns the negotiated stream version.
      Returns:
      negotiated protocol version

    • getEndpointPlain

      String getEndpointPlain()
      Deprecated.
      Retuns the enpoint URL that was given in the constructor.
      Returns:
      Endpoint URL

    • getEndpointUrl

      String getEndpointUrl()
      Deprecated.
      Retuns the enpoint URL that was given in the constructor.
      Returns:
      Endpoint URL

    • getEndpointSSL

      @Deprecated String getEndpointSSL()
      Deprecated.
      Secure connections should be used for all Indexserver calls.
      Retuns the secure enpoint URL that was given in the constructor.
      Returns:
      Endpoint URL
      See Also:

    • isRmi

      @Deprecated boolean isRmi()
      Deprecated.
      Returns true, if Java RMI transport is used.
      Returns:
      Since 6.00.086 always false.

    • isSer

      @Deprecated boolean isSer()
      Deprecated.
      Returns true, if binary transport is used.
      Returns:
      Since 6.00.086 always true.

    • isFastInfoset

      @Deprecated boolean isFastInfoset()
      Deprecated.
      Returns true, if the Fastinfoset transport of JWSDP 2.0 is enabled.
      Returns:
      Since 6.00.086 always false.

    • encryptPassword

      String encryptPassword(String s) throws byps.RemoteException
      Deprecated.
      Use this helper function to encrypt short strings (e. g. passwords). The encryption key is provided by the IX when IXClient.login is called. Only this IX is able to decrypt the string.
      Parameters:
      s - String (password) to be encrypted. Maximum length is 117 characters. resp. 117 UTF-8 bytes.
      Returns:
      encrypted String
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • getUrl

      String getUrl()
      Deprecated.
      Return Indexserver URL
      Returns:
      Indexserver URL

    • loginSso

      LoginResult loginSso(ClientInfo ci, String computerName, boolean keepAlive) throws byps.RemoteException
      Deprecated.
      Login to Indexserver using HTTP authentication.
      Parameters:
      ci - ClientInfo
      computerName - Client computer name
      keepAlive - true, if the ticket should be kept alive by IXClient's background thread
      Returns:
      LoginResult
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

    • getJSESSIONID

      String getJSESSIONID()
      Deprecated.