Package de.elo.ix.client

Class ClientInfo

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.ClientInfo
All Implemented Interfaces:
Serializable
public class ClientInfo extends ValueClass implements Serializable
Contains the session ticket and the users language and country. Each Indexserver interface function, except the login, requires a ClientInfo object as parameter with a valid session ticket.

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:

  • Field Details

    • callId

      protected String callId
      This string is used for debugging purposes only. It is displayed in error messages and reports.

    • country

      protected String country
      Country in ISO 3166 format. This value defines number formats (especially the decimal delimiter) used in numeric values in Sord.objKeys.
      Examples
      CZ Czeach Republic
      FR France
      DE Germany
      A country can also be specified in language.

    • language

      protected String language
      The user's language as IETF language tag. A language is specified as IETF language tag. The language part conforms to ISO 639-1. Starting with IX version 21.3, a language tag is optionally followed by a country tag from ISO 3166-1 alpha-2. The parts are separated by hyphen.
      Examples:
      de German
      de-CH German language in Switzerland
      de-AT German language in Austria
      If a translation for a given language is not found, other language tags are taken into account as described in FindTranslateTermInfo. The country part in this value is overwritten by country if provided.

    • ticket

      protected String ticket

      This is the session ID in the communication between the client and the Indexserver. It has a limited lifetime. The lifetime can be configured at the ELOAM (access manager server). The Indexserver returns a valid ticket if the IXServicePortIF.login call succeeds. The lifetime of the ticket can be extended by calling IXServicePortIF.alive.

      See Also:

    • timeZone

      protected String timeZone
      The time zone for the ELO client. Can be one of the predefined time zone IDs in the Java platform or a string of format "GMT" + sign + hh + ":" + mm.

    • options

      protected int options
      Internal use only. Bit 0 of this member is set for requests that are send from one Indexserver instance to another instance in load balancing scenarios.
      Since:
      8.00.010.000

  • Constructor Details

    • ClientInfo

      public ClientInfo()

    • ClientInfo

      public ClientInfo(String callId, String country, String language, String ticket, String timeZone)
      Constructor
      Parameters:
      callId - String
      country - String
      language - String
      ticket - String
      timeZone - String

    • ClientInfo

      public ClientInfo(ClientInfo rhs)

    • ClientInfo

      public ClientInfo(String ticket)

  • Method Details

    • getDefault

      public static ClientInfo getDefault()
      This ClientInfo object is used by default in REST calls if the client does not provide one. EIX-2651

    • getCallId

      public String getCallId()

    • setCallId

      public void setCallId(String callId)

    • getCountry

      public String getCountry()

    • setCountry

      public void setCountry(String country)

    • getLanguage

      public String getLanguage()

    • setLanguage

      public void setLanguage(String language)

    • getTicket

      public String getTicket()

    • setTicket

      public void setTicket(String ticket)

    • getTimeZone

      public String getTimeZone()

    • setTimeZone

      public void setTimeZone(String timeZone)

    • getOptions

      public int getOptions()

    • setOptions

      public void setOptions(int options)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object