Class Constants


  • public final class Constants
    extends java.lang.Object
    Utility class with constant for several purposes.
    • Field Detail

      • PUBSERVER_INSTANCE_NAME

        public static final java.lang.String PUBSERVER_INSTANCE_NAME
        Unique name of the pubserver instance within a cluster. Defaults to the name of the current GlassFish instance (i.e. "server" on a non clustered system). May be overridden by a container system property named "PUBSERVER_NAME". Example: PubServer01 or PubServerNode_01_Instance01
      • PUBSERVER_SESSSION_NAME

        public static final java.lang.String PUBSERVER_SESSSION_NAME
        Name of the pubserver sessions for use in http cookies or headers. Defaults to "PubServSessID". May be overridden by system setting
      • MANAGER_PLUGIN

        public static final java.lang.String MANAGER_PLUGIN
        JNDI Name for PluginManagerLocal (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_PLUGIN_REMOTE

        public static final java.lang.String MANAGER_PLUGIN_REMOTE
        JNDI Name for PluginManagerRemote (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_SESSION

        public static final java.lang.String MANAGER_SESSION
        JNDI Name for SessionManagerLocal (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_TRACE

        public static final java.lang.String MANAGER_TRACE
        JNDI Name for SessionManagerLocal (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_ERRORCODE

        public static final java.lang.String MANAGER_ERRORCODE
        JNDI Name for ErrorCodeManagerLocal (Plugin ErrorCodeManager)
        See Also:
        Constant Field Values
      • MANAGER_ENTITY

        public static final java.lang.String MANAGER_ENTITY
        Mapped name of Entity Manager, for use in PluginUtils.getPlugin with class EntityManagerLocal.
        See Also:
        Constant Field Values
      • MANAGER_ENTITY_REMOTE

        public static final java.lang.String MANAGER_ENTITY_REMOTE
        JNDI Name for PubServerEntityManagerRemote (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_DATAPROVIDER

        public static final java.lang.String MANAGER_DATAPROVIDER
        Mapped name of Data Provider Manager, for use in PluginUtils.getPlugin with class DataProviderManagerLocal.
        See Also:
        Constant Field Values
      • MANAGER_DATAPROVIDER_REMOTE

        public static final java.lang.String MANAGER_DATAPROVIDER_REMOTE
        JNDI Name for PubServerDataProviderManagerRemote (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_DOCUMENT

        public static final java.lang.String MANAGER_DOCUMENT
        JNDI Name for DocumentManager (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_DOCUMENT_LOCK

        public static final java.lang.String MANAGER_DOCUMENT_LOCK
        JNDI Name for DocumentManagerLock (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_CLIENT

        public static final java.lang.String MANAGER_CLIENT
        JNDI Name for DocumentManagerLock (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_CONFIG_REMOTE

        public static final java.lang.String MANAGER_CONFIG_REMOTE
        JNDI Name for ConfigManagerRemote (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_CONFIG

        public static final java.lang.String MANAGER_CONFIG
        JNDI Name for ConfigManagerLocal (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_AUTH

        public static final java.lang.String MANAGER_AUTH
        JNDI Name for AuthorizationScannerLocal (Kernel Manager Bean)
        See Also:
        Constant Field Values
      • MANAGER_ASYNC_CALL

        public static final java.lang.String MANAGER_ASYNC_CALL
        JNDI Name for AsyncCall Plugin
        See Also:
        Constant Field Values
      • MANAGER_COMET_CONFIGURATION

        public static final java.lang.String MANAGER_COMET_CONFIGURATION
        Mapped name of Comet Configuration, for use in PluginUtils.getPlugin with class CometConfigurationLocal.
        See Also:
        Constant Field Values
      • MANAGER_ENTITY_MODEL_REPORT

        public static final java.lang.String MANAGER_ENTITY_MODEL_REPORT
        Mapped name of Entity Model Report, for use in PluginUtils.getPlugin with class EntityModelReport.
        See Also:
        Constant Field Values
      • MANAGER_USER

        public static final java.lang.String MANAGER_USER
        Mapped name of User Manager, for use in PluginUtils.getPlugin with class AuthenticationLocal.
        See Also:
        Constant Field Values
      • MANAGER_MEDIA_ASSET

        public static final java.lang.String MANAGER_MEDIA_ASSET
        JNDI Name for MediaAssetManager
        See Also:
        Constant Field Values
      • CONNECTOR_PUBLISHING_HUB_DB

        public static final java.lang.String CONNECTOR_PUBLISHING_HUB_DB
        JNDI Name for Connector PublishingHubDB
        See Also:
        Constant Field Values
      • COMETSERVER_CONNECTION_BEAN

        @Deprecated
        public static final java.lang.String COMETSERVER_CONNECTION_BEAN
        Deprecated.
        JNDI Name for CometServerLight ConnectionBean
        See Also:
        Constant Field Values
      • PUBSERVER_DEPLOYMENT_MANAGER

        public static final java.lang.String PUBSERVER_DEPLOYMENT_MANAGER
        JNDI Name for PubServerDeploymentManager bean
        See Also:
        Constant Field Values
      • ANONYMOUS_LOGIN

        public static final java.lang.String ANONYMOUS_LOGIN
        Login name for the anonymous user
        See Also:
        Constant Field Values
      • PUBSERVER_NUM_INSTANCES

        public static final int PUBSERVER_NUM_INSTANCES
        The numbers of instances supported in one environment (i.e. company, customer etc.). A instance can be the
        • development server
        • test server
        • integration server
        • temporary instance for migration
        • productive system
        • etc.
        At the time this is limited to a maximum of 32 (actually 31) instances. Each instance has a unique and proprietary ID space, starting with
          Math.pow(2, 31 - Math.log(PUBSERVER_NUM_INSTANCES) / Math.log (2)) * Instance-ID
        to   Math.pow(2, 31 - Math.log(PUBSERVER_NUM_INSTANCES) / Math.log (2)) * (Instance-ID + 1) - 1

        Do not set PUBSERVER_NUM_INSTANCES too high, because this will impact the the number of available IDs per instance.
      • PUBSERVER_INSTANCE_ID

        public static final int PUBSERVER_INSTANCE_ID
        This instance number. The instance number must be unique in a environment (i.e. company, customer) and within the range 1 .. PUBSERVER_NUM_INSTANCES
      • PLUGIN_CONFIG_PATH

        public static final java.lang.String PLUGIN_CONFIG_PATH
        Base path of configuration files in the repository.

        A typical configuration file will be located via

        ${PLUGIN_CONFIG_PATH}/${PluginMappedName}/${ClientName}/defaultConfig.xml

        See Also:
        Constant Field Values
      • PLUGIN_CONFIG_TRASH

        public static final java.lang.String PLUGIN_CONFIG_TRASH
        Base path of deleted configuration files in the repository.

        Do not use this in custom plug-in code.

        See Also:
        Constant Field Values
      • IN_DESIGN_SERVERS_PATH

        public static final java.lang.String IN_DESIGN_SERVERS_PATH
        Base path of InDesignServers configuration list in the repository.
        See Also:
        Constant Field Values
      • PLUGIN_CONFIG_DEFAULT

        public static final java.lang.String PLUGIN_CONFIG_DEFAULT
        Folder name for default configuration files in the repository. Files in this folder are automatically loaded during plugin registration.

        A typical configuration file will be located via

        ${PLUGIN_CONFIG_PATH}/${PluginMappedName}/${ClientName}/default/defaultConfig.xml

        See Also:
        Constant Field Values
      • PLUGIN_CONFIG_CUSTOM

        public static final java.lang.String PLUGIN_CONFIG_CUSTOM
        Folder name for custom configuration files in the repository. The loading of these files are must be implemented in the plugin startup methods.

        A typical configuration file will be located via

        ${PLUGIN_CONFIG_PATH}/${PluginMappedName}/${ClientName}/default/defaultConfig.xml

        See Also:
        Constant Field Values
      • NOTIFY_CREATE

        public static final java.lang.String NOTIFY_CREATE
        To signal that a repository check-in is meant as an insert.
        See Also:
        Constant Field Values
      • NOTIFY_UPDATE

        public static final java.lang.String NOTIFY_UPDATE
        To signal that a repository check-in is meant as an update.
        See Also:
        Constant Field Values
      • REALM_NAME

        public static final java.lang.String REALM_NAME
        Shiro realm name for default usermanager
        See Also:
        Constant Field Values
      • USERS_PATH

        public static final java.lang.String USERS_PATH
        Repository path to user configurations (if default usermanager is used)
        See Also:
        Constant Field Values
      • SESSION_INFO_KEY

        public static final java.lang.String SESSION_INFO_KEY
        Used when we set SessionInfo as Session attribute and when we get comet server sessions
        See Also:
        Constant Field Values
      • COMETPDF_INSTALLATIONPATH_PROPERTY_KEY

        public static final java.lang.String COMETPDF_INSTALLATIONPATH_PROPERTY_KEY

        Property name for installation path of Comet PDF Renderer

        The Comet PDF Renderer installation path is a mandatory system setting for remote PDF renderer.

        See Also:
        Constant Field Values
      • COMETPDF_WORKINGDIRECTORY_PROPERTY_KEY

        public static final java.lang.String COMETPDF_WORKINGDIRECTORY_PROPERTY_KEY

        Property name for working directory of Comet PDF Renderer

        The Comet PDF Renderer working directory is a mandatory system setting for remote PDF renderer.

        See Also:
        Constant Field Values
      • COMETPDF_WRITELOGFILES_PROPERTY_KEY

        public static final java.lang.String COMETPDF_WRITELOGFILES_PROPERTY_KEY

        Property name for the PDF renderer configuration log flag.

        This flag controls, whether log files should be written by the PDF renderer or not.

        See Also:
        Constant Field Values
      • COMETPDF_USELOCKFILES_PROPERTY_KEY

        public static final java.lang.String COMETPDF_USELOCKFILES_PROPERTY_KEY

        Property name for the PDF renderer configuration lock property.

        This flag controls, whether a lock file should be created during command processing or not. Usually, creating lock files should not be required, in older versions it was sometimes necessary to work around timing problems when running commands via System.exec.

        See Also:
        Constant Field Values
      • UNDEFINED_VARIABLE

        public static final java.lang.String UNDEFINED_VARIABLE
        Null used for the undefined variable
      • UNDEFINED

        public static final java.lang.String UNDEFINED
        Empty String used for undefined
        See Also:
        Constant Field Values
      • EMPTY_STRING

        public static final java.lang.String EMPTY_STRING
        Empty String
        See Also:
        Constant Field Values
      • PARAM_ENTITY_MODEL

        public static final java.lang.String PARAM_ENTITY_MODEL
        entityModelIdentifier String
        See Also:
        Constant Field Values
      • PARAM_ENTITY_IDENTIFIER

        public static final java.lang.String PARAM_ENTITY_IDENTIFIER
        entityIdentifier String
        See Also:
        Constant Field Values
      • PARAM_RECORD_IDENTIFIER

        public static final java.lang.String PARAM_RECORD_IDENTIFIER
        identifier String
        See Also:
        Constant Field Values
      • PARAM_SESSION_ID

        public static final java.lang.String PARAM_SESSION_ID
        sessionId String
        See Also:
        Constant Field Values
      • PARAM_DOCUMENT_ID

        public static final java.lang.String PARAM_DOCUMENT_ID
        documentId String
        See Also:
        Constant Field Values
      • PARAM_TIMESTAMP

        public static final java.lang.String PARAM_TIMESTAMP
        timestamp String
        See Also:
        Constant Field Values
      • PARAM_RESULT_ENTITY

        public static final java.lang.String PARAM_RESULT_ENTITY
        resultEntityId String
        See Also:
        Constant Field Values
      • PARAM_SEARCH_STRING

        public static final java.lang.String PARAM_SEARCH_STRING
        searchStr String
        See Also:
        Constant Field Values
      • PARAM_GROUP_ID

        public static final java.lang.String PARAM_GROUP_ID
        recordGroupIdentifier String
        See Also:
        Constant Field Values
      • PARAM_RESOLUTION

        public static final java.lang.String PARAM_RESOLUTION
        resolution String
        See Also:
        Constant Field Values
      • PARAM_FORMAT

        public static final java.lang.String PARAM_FORMAT
        format String
        See Also:
        Constant Field Values
      • PARAM_SPREAD_INDEX

        public static final java.lang.String PARAM_SPREAD_INDEX
        spreadIndex String
        See Also:
        Constant Field Values
      • PARAM_PAGE_INDEX

        public static final java.lang.String PARAM_PAGE_INDEX
        pageIndex String
        See Also:
        Constant Field Values
      • PARAM_TEMPLATE_ID

        public static final java.lang.String PARAM_TEMPLATE_ID
        templateId String
        See Also:
        Constant Field Values
      • PARAM_TEMPLATE

        public static final java.lang.String PARAM_TEMPLATE
        template String
        See Also:
        Constant Field Values
      • PARAM_PROJECT

        public static final java.lang.String PARAM_PROJECT
        project String
        See Also:
        Constant Field Values
      • PARAM_USE_ONLY_CACHE

        public static final java.lang.String PARAM_USE_ONLY_CACHE
        useOnlyCache String
        See Also:
        Constant Field Values
      • PARAM_REMOVE_FROM_CACHE

        public static final java.lang.String PARAM_REMOVE_FROM_CACHE
        removeFromCache String
        See Also:
        Constant Field Values
      • PARAM_DELETE_TMP_REALGRIDELEMENT

        public static final java.lang.String PARAM_DELETE_TMP_REALGRIDELEMENT
        deleteTmpRealGridElement String
        See Also:
        Constant Field Values