Package de.elo.ix.client

Class SessionOptionsC

java.lang.Object
de.elo.ix.client.SessionOptionsC
All Implemented Interfaces:
Serializable
public class SessionOptionsC extends Object implements Serializable
Constants of SessionOptions.
See Also:

  • Field Details

    • CLIENT_APP_NAME

      public static final String CLIENT_APP_NAME
      Client application name. Optional.
      See Also:

    • CLIENT_APP_VERSION

      public static final String CLIENT_APP_VERSION
      Client application version. Optional.
      See Also:

    • CLIENT_APP_TYPE

      public static final String CLIENT_APP_TYPE
      Client application type. Mandatory. The appropriate value for partner applications is TYPE_PARTNER_APPLICATION unless a special type is arranged.
      See Also:

    • TYPE_PARTNER_APPLICATION

      public static final String TYPE_PARTNER_APPLICATION
      This option value has to be used for option CLIENT_APP_TYPE if a partner application connects to IX.
      See Also:

    • APP_TYPE_MINI_CLIENT

      public static final String APP_TYPE_MINI_CLIENT
      Reserved. This value is reserved for ELO applications. Unauthorized usage violates the ELO licensing terms.
      Since:
      10.17.010.001
      See Also:

    • DB_ESCAPE_CHAR

      public static final String DB_ESCAPE_CHAR
      This character is used in the SQL statement, if the search criterias contain one of the SQL wildcard characters: "%", "_". It defaults to "¶" which is a reserved character in ELO and a valid escape character for the most SQL servers and configurations. Unless a search kritera contains "¶" or the SQL server does not allow the use of this character (e. g. ORACLE, UTF-8) the value has to be changed. Hint: Indexserver-API uses "*" as the only valid wildcard. The escape character must not be used in the search criterias.
      See Also:

    • DB_WILDCARDS

      public static final String DB_WILDCARDS
      This characters are used as wildcards in search terms. The first wildcard is used for zero or more characters. The second wildcard is used for exactly one character. By default (if this member is null or empty), only the first wildcard is defined: *
      See Also:

    • DIRECT_DM_ACCESS

      @Deprecated public static final String DIRECT_DM_ACCESS
      Deprecated.
      This option is ignored since ELO 9.0
      This option specifies which application is addressed in URLs to upload and download documents. If direct access is true, the URLs address the DM directly. Otherwise the documents are routed though the IX.
      See Also:

    • ENCRYPT_DOCUMENTS

      public static final String ENCRYPT_DOCUMENTS
      Set this option to encrypt documents on checkin. A secure connection (HTTPS) is required to use this option.
      See Also:

    • DECRYPT_DOCUMENTS

      public static final String DECRYPT_DOCUMENTS
      Set this option to decrypt documents on checkout. A secure connection (HTTPS) is required to use this option.
      See Also:

    • TRANSLATE_TERMS

      public static final String TRANSLATE_TERMS
      Translate keywording forms names, index names, index values and keyword lists into resp. from the language given in ClientInfo.language.
      Since:
      7.00.000.004
      See Also:

    • ISO_DATE_WITH_DELIMS

      public static final String ISO_DATE_WITH_DELIMS
      Format ISO date values with delimiter characters defined in ISO 8601.
      See Also:

    • START_DOCMASK_WORKFLOWS

      public static final String START_DOCMASK_WORKFLOWS
      If this option is set to "true", the Indexserver starts the workflow defined in DocMask.flowId and DocMask.flowId2 when an associated document is created or checked in.
      See Also:

    • ACTIVE_ROLES

      public static final String ACTIVE_ROLES
      Comma separated list of active role IDs.
      Since:
      20.00.000.003
      See Also:

    • SESSION_FROM_IX

      public static final int SESSION_FROM_IX
      Function getSessionFromTicket: session must be known by this Indexserver instance. An exception is thrown, if the session is not known by this Indexserver instance. The ticket lifetime is extended.
      Since:
      7.00.022.001
      See Also:

    • SESSION_FROM_AM

      public static final int SESSION_FROM_AM
      Function getSessionFromTicket: any active session known by the AccessManager can be requested. The session is not inserted into the session management of this Indexserver instance. Thus the session cannot be used to make Indexserver function calls. The ticket lifetime is not extended.
      Since:
      7.00.022.001
      See Also:

    • SESSION_ADD

      public static final int SESSION_ADD
      Function getSessionFromTicket: used in combination with SESSION_FROM_AM. Add the session into the internal session management.
      See Also:

    • SESSION_FROM_AM_ADD

      public static final int SESSION_FROM_AM_ADD
      Function getSessionFromTicket: any active session can be requested and is inserted into the session management of this Indexserver instance. If the session is not known by this Indexserver instance, it is assumed to be a Windows CLIENT session (relevant to license model). The ticket lifetime is extended. This value is the same as SESSION_FROM_AM | SESSION_ADD.
      Since:
      7.00.022.001
      See Also:

    • IX_URL_BASE

      public static final String IX_URL_BASE
      Define the first part of the URLs generated from Indexserver. See configuration option ixUrlBase on the Indexserver option page.
      See Also:

    • DOC_URL_BASE

      @Deprecated public static final String DOC_URL_BASE
      Deprecated.
      This option is ignored since ELO 9.0
      Define the first part of the document URLs generated from Indexserver. See configuration option documentUrlBase on the Indexserver option page.
      See Also:

    • DOWNLOAD_URL_TYPE

      public static final String DOWNLOAD_URL_TYPE
      Define the download URL type. IX can generate several types of URLs to download documents. Possible values are the constants DOWNLOAD_URL_TYPE_*. The default value is DOWNLOAD_URL_TYPE_TEMPORARY.
      Since:
      8.00.028.001
      See Also:

    • DOWNLOAD_URL_TYPE_TEMPORARY

      public static final String DOWNLOAD_URL_TYPE_TEMPORARY
      Generate URLs that expire after a given time. The lifetime can be specified with the option "documentUrlLifetimeSeconds". By default, all URLs are created with a constrained lifetime.
      Since:
      8.00.028.001
      See Also:

    • DOWNLOAD_URL_TYPE_PERSISTENT

      public static final String DOWNLOAD_URL_TYPE_PERSISTENT
      Generate URLs that do not expire. IX generates URLs that can be used without time limitation. The URL includes a strongly encrypted ID of the document or attachment version. AES is used to encrypt the URL parameters. The AES key is read from the IX option AESEncryptionKey.
      ATTENTION: If the key AESEncryptionKey is changed, all URLs generated before become invalid!
      ATTENTION: No access checking is performed, when the document is downloaded from the URL! Everyone who knows the URL and has access to ELOix can download the document. This option cannot not be used for documents with blackening. No URL is generated for those documents.
      Only main administrators can use this option. The document is accessed by the IX account. Authentication is not required or performed.
      Since:
      8.00.028.001
      See Also:

    • DOWNLOAD_URL_TYPE_PUBLIC

      @Deprecated public static final String DOWNLOAD_URL_TYPE_PUBLIC
      Deprecated.
      Generate public download URLs for the actual working version, that expire after a given time. Only a given number of downloads is allowed. IX generates URLs that can be used by non ELO users. The URL includes a strongly encrypted ID of the document or attachment version. AES is used to encrypt the URL parameters. The AES key is read from the IX option AESEncryptionKey.
      ATTENTION: If the key AESEncryptionKey is changed, all URLs generated before become invalid!
      ATTENTION: No access checking is performed, when the document is downloaded from the URL! Everyone who knows the URL and has access to ELOix can download the document. This option cannot not be used for documents with blackening. No URL is generated for those documents.
      Authentication is not required or performed.
      Since:
      9.00.014.003
      See Also:

    • DOWNLOAD_URL_TYPE_PUBLIC_VERSION

      @Deprecated public static final String DOWNLOAD_URL_TYPE_PUBLIC_VERSION
      Deprecated.
      Generate public download URLs for the document version, that expire after a given time.. Only a given number of downloads is allowed. IX generates URLs that can be used by non ELO users. The URL includes a strongly encrypted ID of the document or attachment version. AES is used to encrypt the URL parameters. The AES key is read from the IX option AESEncryptionKey.
      ATTENTION: If the key AESEncryptionKey is changed, all URLs generated before become invalid!
      ATTENTION: No access checking is performed, when the document is downloaded from the URL! Everyone who knows the URL and has access to ELOix can download the document. This option cannot not be used for documents with blackening. No URL is generated for those documents.
      Authentication is not required or performed.
      Since:
      9.00.014.003
      See Also:

    • PUBLIC_DOWNLOAD_COUNT

      @Deprecated public static final String PUBLIC_DOWNLOAD_COUNT
      Deprecated.
      Define the allowed number of public downloads.
      Since:
      9.00.014.003
      See Also:

    • PUBLIC_DOWNLOAD_EXPIREDTIME

      @Deprecated public static final String PUBLIC_DOWNLOAD_EXPIREDTIME
      Deprecated.
      Define the expired time of public downloads.
      Since:
      9.00.014.003
      See Also:

    • APPLY_ALL_BLACKENINGS

      public static final String APPLY_ALL_BLACKENINGS
      Apply all blackenings on documents regardless of their ACL. ELOtr sets this option as "true" to receive documents with all blackenings. This ensures that blackened parts cannot be retrieved by a fulltext search. TTS003793
      Since:
      10.17.010.009
      See Also:

    • DISABLE_CHANGE_INFO_PROTECTION

      public static final String DISABLE_CHANGE_INFO_PROTECTION
      If set, this option disables the protection of change information.

      Disabling the writing of changes information causes the Indexserver to not update the *tstamp* database columns. Then, the client has to ensure that the time stamps of objects are set correctly. Setting this option without reason causes the loss of traceability of objects in the archive! Only the replication module should use this option.

      The replication searches the database for changes since the last replication run. The gathered changes will be transported to other sites and imported into the database there. Such an import must not trigger the writing of change informations as further this would trigger the export of these changes again, claiming the changes would have been made at the site importing the changes.

      Since:
      9.99.009.001
      See Also:

    • HANDLE_IX_SERVER_EVENTS

      public static final String HANDLE_IX_SERVER_EVENTS
      This session option declares that the IXConnection handles server events declared in IXServerEvents.
      Since:
      10.17.030.001
      See Also:

    • HTTP_SESSION_IX_CONNECTION

      public static final String HTTP_SESSION_IX_CONNECTION
      Attribute name to which Indexserver maps an IXConnection in the HTTP Session
      Since:
      11.00.000.044
      See Also:

    • HTTP_SESSION_TICKET

      public static final String HTTP_SESSION_TICKET
      Attribute name to which Indexserver maps a Ticket in the HTTP Session
      Since:
      11.00.000.044
      See Also:

    • DISABLE_LOGGING_API_CALLS

      public static final String DISABLE_LOGGING_API_CALLS
      Disable logging of API calls for this session. EIX-3303
      Since:
      21.04.000.005
      See Also:

    • COPY_OBJKEYS_IN_BACKGROUND

      public static final String COPY_OBJKEYS_IN_BACKGROUND
      Control the synchronicity of copying objkeys to child entries.
      Since:
      21.04.000.007
      See Also:

  • Constructor Details

    • SessionOptionsC

      public SessionOptionsC()

  • Method Details

    • getDISABLE_WRITE_CHANGE_INFO

      public static String getDISABLE_WRITE_CHANGE_INFO()

    • setDISABLE_WRITE_CHANGE_INFO

      public static void setDISABLE_WRITE_CHANGE_INFO(String DISABLE_WRITE_CHANGE_INFO)

    • getCLIENT_APP_NAME

      public String getCLIENT_APP_NAME()

    • setCLIENT_APP_NAME

      public void setCLIENT_APP_NAME(String CLIENT_APP_NAME)

    • getCLIENT_APP_TYPE

      public String getCLIENT_APP_TYPE()

    • setCLIENT_APP_TYPE

      public void setCLIENT_APP_TYPE(String CLIENT_APP_TYPE)

    • getCLIENT_APP_VERSION

      public String getCLIENT_APP_VERSION()

    • setCLIENT_APP_VERSION

      public void setCLIENT_APP_VERSION(String CLIENT_APP_VERSION)

    • getDB_ESCAPE_CHAR

      public String getDB_ESCAPE_CHAR()

    • setDB_ESCAPE_CHAR

      public void setDB_ESCAPE_CHAR(String DB_ESCAPE_CHAR)

    • getDIRECT_DM_ACCESS

      public String getDIRECT_DM_ACCESS()

    • setDIRECT_DM_ACCESS

      public void setDIRECT_DM_ACCESS(String DIRECT_DM_ACCESS)

    • getTYPE_PARTNER_APPLICATION

      public String getTYPE_PARTNER_APPLICATION()

    • setTYPE_PARTNER_APPLICATION

      public void setTYPE_PARTNER_APPLICATION(String TYPE_PARTNER_APPLICATION)

    • getDECRYPT_DOCUMENTS

      public String getDECRYPT_DOCUMENTS()

    • setDECRYPT_DOCUMENTS

      public void setDECRYPT_DOCUMENTS(String DECRYPT_DOCUMENTS)

    • getENCRYPT_DOCUMENTS

      public String getENCRYPT_DOCUMENTS()

    • setENCRYPT_DOCUMENTS

      public void setENCRYPT_DOCUMENTS(String ENCRYPT_DOCUMENTS)

    • getTRANSLATE_TERMS

      public String getTRANSLATE_TERMS()

    • setTRANSLATE_TERMS

      public void setTRANSLATE_TERMS(String TRANSLATE_TERMS)

    • getISO_DATE_WITH_DELIMS

      public String getISO_DATE_WITH_DELIMS()

    • setISO_DATE_WITH_DELIMS

      public void setISO_DATE_WITH_DELIMS(String v)

    • getSESSION_FROM_IX

      public int getSESSION_FROM_IX()

    • setSESSION_FROM_IX

      public void setSESSION_FROM_IX(int sESSIONFROMIX)

    • getSESSION_FROM_AM

      public int getSESSION_FROM_AM()

    • setSESSION_FROM_AM

      public void setSESSION_FROM_AM(int sESSIONFROMAM)

    • getSESSION_FROM_AM_ADD

      public int getSESSION_FROM_AM_ADD()

    • setSESSION_FROM_AM_ADD

      public void setSESSION_FROM_AM_ADD(int sESSIONFROMAMADD)

    • getSESSION_ADD

      public int getSESSION_ADD()

    • setSESSION_ADD

      public void setSESSION_ADD(int sESSIONADD)

    • getDB_WILDCARDS

      public String getDB_WILDCARDS()

    • setDB_WILDCARDS

      public void setDB_WILDCARDS(String DB_WILDCARDS)

    • getIX_URL_BASE

      public String getIX_URL_BASE()

    • setIX_URL_BASE

      public void setIX_URL_BASE(String iXURLBASE)

    • getDOC_URL_BASE

      public String getDOC_URL_BASE()

    • setDOC_URL_BASE

      public void setDOC_URL_BASE(String dOCURLBASE)

    • getDOWNLOAD_URL_TYPE

      public String getDOWNLOAD_URL_TYPE()

    • setDOWNLOAD_URL_TYPE

      public void setDOWNLOAD_URL_TYPE(String dOWNLOAD_URL_TYPE)

    • getDOWNLOAD_URL_TYPE_TEMPORARY

      public String getDOWNLOAD_URL_TYPE_TEMPORARY()

    • setDOWNLOAD_URL_TYPE_TEMPORARY

      public void setDOWNLOAD_URL_TYPE_TEMPORARY(String dOWNLOAD_URL_TYPE_TEMPORARY)

    • getDOWNLOAD_URL_TYPE_PERSISTENT

      public String getDOWNLOAD_URL_TYPE_PERSISTENT()

    • setDOWNLOAD_URL_TYPE_PERSISTENT

      public void setDOWNLOAD_URL_TYPE_PERSISTENT(String dOWNLOAD_URL_TYPE_PERSISTENT)

    • getPUBLIC_DOWNLOAD_EXPIREDTIME

      public static String getPUBLIC_DOWNLOAD_EXPIREDTIME()

    • setPUBLIC_DOWNLOAD_EXPIREDTIME

      public static void setPUBLIC_DOWNLOAD_EXPIREDTIME(String PUBLIC_DOWNLOAD_EXPIREDTIME)

    • getDOWNLOAD_URL_TYPE_PUBLIC

      public static String getDOWNLOAD_URL_TYPE_PUBLIC()

    • setDOWNLOAD_URL_TYPE_PUBLIC

      public static void setDOWNLOAD_URL_TYPE_PUBLIC(String DOWNLOAD_URL_TYPE_PUBLIC)

    • getPUBLIC_DOWNLOAD_COUNT

      public static String getPUBLIC_DOWNLOAD_COUNT()

    • setPUBLIC_DOWNLOAD_COUNT

      public static void setPUBLIC_DOWNLOAD_COUNT(String PUBLIC_DOWNLOAD_COUNT)

    • getCOPY_OBJKEYS_IN_BACKGROUND

      public static String getCOPY_OBJKEYS_IN_BACKGROUND()

    • setCOPY_OBJKEYS_IN_BACKGROUND

      public static void setCOPY_OBJKEYS_IN_BACKGROUND(String COPY_OBJKEYS_IN_BACKGROUND)