Package org.appng.api

Class Platform.Property

  • Enclosing class:
    Platform

    public final class Platform.Property
    extends Object
    Constants used for the global platform-configuration. Those get wrapped into a Properties-object and can be accessed via the Environment as follows:
     org.appng.api.model.Properties platformConfig = environment.getAttribute(Scope.PLATFORM,
                    Platform.Environment.PLATFORM_CONFIG);
     String platformRootPath = platformConfig.getString(Platform.Property.PLATFORM_ROOT_PATH);
     
    Note: A Application can only access the Scope.PLATFORM if it's a privileged application, i.e. Application.isPrivileged() returns true.
    Author:
    Matthias Müller
    • Field Detail

      • PLATFORM_ROOT_PATH

        public static final String PLATFORM_ROOT_PATH
        The absolute root-path of the platform
        See Also:
        Constant Field Values
      • APPLICATION_CACHE_FOLDER

        public static final String APPLICATION_CACHE_FOLDER
        The folder for the application-cache, relative to CACHE_FOLDER. Applications might use this folder to cache temporary data.
        See Also:
        Constant Field Values
      • CLEAN_TEMP_FOLDER_ON_STARTUP

        public static final String CLEAN_TEMP_FOLDER_ON_STARTUP
        If set to true, the temp folder (defined by the system property java.io.tmpdir) is cleaned on a platform startup. WARNING: Only set to true if appNG was started with a custom value (e.g. -Djava.io.tmpdir=/appng-temp).
        See Also:
        Constant Field Values
      • CACHE_CONFIG

        public static final String CACHE_CONFIG
        The global configuration for configuring caching. This property either contains the platform-relative path to a config file (e.g. WEB-INF/conf/hazelcast.xml) or the XML configuration itself in XML format (stored as multiline value).
        See Also:
        Constant Field Values
      • CSRF_FILTER_ENABLED

        public static final String CSRF_FILTER_ENABLED
        Set to true to enable a filter preventing CSRF-attacks
        See Also:
        Constant Field Values
      • DATABASE_PREFIX

        public static final String DATABASE_PREFIX
        The prefix to use when generating database names
        See Also:
        Constant Field Values
      • DATABASE_VALIDATION_PERIOD

        public static final String DATABASE_VALIDATION_PERIOD
        The idle database connection test period in minutes. If a database connection remains idle for the specified time, the validation query defined in the database connection will be sent to prevent a database connection timeout.
        See Also:
        Constant Field Values
      • DEV_MODE

        public static final String DEV_MODE
        Disable for production use. If enabled, XML and XSL resources will be written to the cache directory. If disabled, XML and XSL resources will be cached in memory.
        See Also:
        Constant Field Values
      • FILEBASED_DEPLOYMENT

        public static final String FILEBASED_DEPLOYMENT
        Set to 'true' if applications should be deployed to the local filesystem, 'false' otherwise.
        See Also:
        Constant Field Values
      • FORMAT_OUTPUT

        public static final String FORMAT_OUTPUT
        Disable for production use. If enabled, debugging is easier, but Textarea values are formatted wrong.
        See Also:
        Constant Field Values
      • HEART_BEAT_INTERVAL

        public static final String HEART_BEAT_INTERVAL
        The interval in which the heartbeat is sent (seconds)
        See Also:
        Constant Field Values
      • IMAGEMAGICK_PATH

        public static final String IMAGEMAGICK_PATH
        The path to the ImageMagick executables
        See Also:
        Constant Field Values
      • INACTIVE_LOCK_PERIOD

        public static final String INACTIVE_LOCK_PERIOD
        The number of days after a Subject get's locked if the user did not log in.
        See Also:
        Constant Field Values
      • MAIL_DISABLED

        public static final String MAIL_DISABLED
        Set to 'true' to disable mailing and log the e-mails instead.
        See Also:
        Constant Field Values
      • MANAGE_DATABASES

        public static final String MANAGE_DATABASES
        If set to 'true', appNG will manage the databases (create schemas and users) required by the Applications.
        See Also:
        Constant Field Values
      • MAINTENANCE_SCREEN

        public static final String MAINTENANCE_SCREEN
        A multilined property containing a maintenance screen
        See Also:
        Constant Field Values
      • MDC_ENABLED

        public static final String MDC_ENABLED
        set to true to enable support for Mapped Diagnostic Context (MDC) Logging.
        See Also:
        Constant Field Values
      • MESSAGING_ENABLED

        public static final String MESSAGING_ENABLED
        Set to true to enable cluster messaging
        See Also:
        Constant Field Values
      • MESSAGING_RECEIVER

        public static final String MESSAGING_RECEIVER
        Class name of the desired messaging Receiver implementation.
        See Also:
        Constant Field Values
      • MESSAGING_GROUP_ADDRESS

        public static final String MESSAGING_GROUP_ADDRESS
        The multicast address used for messaging
        See Also:
        Constant Field Values
      • MESSAGING_GROUP_PORT

        public static final String MESSAGING_GROUP_PORT
        The port used for multicast messaging
        See Also:
        Constant Field Values
      • MAX_UPLOAD_SIZE

        public static final String MAX_UPLOAD_SIZE
        The maximum size for file uploads in bytes
        See Also:
        Constant Field Values
      • MONITOR_PERFORMANCE

        public static final String MONITOR_PERFORMANCE
        Set to true to enable performance monitoring for the target XML
        See Also:
        Constant Field Values
      • PARALLEL_SITE_STARTS

        public static final String PARALLEL_SITE_STARTS
        Start sites in parallel true|false ?
        See Also:
        Constant Field Values
      • PASSWORD_MAX_VALIDITY

        public static final String PASSWORD_MAX_VALIDITY
        The maximum number of days a password is valid, where -1 means forever
        See Also:
        Constant Field Values
      • PASSWORD_POLICY_ERROR_MSSG_KEY

        public static final String PASSWORD_POLICY_ERROR_MSSG_KEY
        The resource-bundle key (for messages-core) for the message which is being displayed when the password does not match the policy.
        See Also:
        Constant Field Values
      • PASSWORD_POLICY_REGEX

        public static final String PASSWORD_POLICY_REGEX
        A regular expression describing the password-policy
        See Also:
        Constant Field Values
      • PLATFORM_CACHE_FOLDER

        public static final String PLATFORM_CACHE_FOLDER
        The folder for the platform-cache, relative to CACHE_FOLDER. The platform cache is used by appNG to cache application resources.
        See Also:
        Constant Field Values
      • APPLICATION_DIR

        public static final String APPLICATION_DIR
        The folder used for installing file-based-applications, relative to the webapp-root
        See Also:
        Constant Field Values
      • REPOSITORY_PATH

        public static final String REPOSITORY_PATH
        The folder used for the repositories of the site, relative to the webapp-root
        See Also:
        Constant Field Values
      • SESSION_TIMEOUT

        public static final String SESSION_TIMEOUT
        The timeout for a user session in seconds
        See Also:
        Constant Field Values
      • SHARED_SECRET

        public static final String SHARED_SECRET
        The shared secret used for digest authentication
        See Also:
        Constant Field Values
      • TEMPLATE_FOLDER

        public static final String TEMPLATE_FOLDER
        The folder used for templates, relative to the webapp-root
        See Also:
        Constant Field Values
      • TEMPLATE_PREFIX

        public static final String TEMPLATE_PREFIX
        The path under which the resources of the active template are beeing served.
        See Also:
        Constant Field Values
      • UPLOAD_DIR

        public static final String UPLOAD_DIR
        The folder for saving uploads, relative to the webapp-root
        See Also:
        Constant Field Values
      • VHOST_MODE

        public static final String VHOST_MODE
        Defines whether the server is identified by its IP ('IP_BASED') or by its name ('NAME_BASED')
        See Also:
        Constant Field Values
      • WRITE_DEBUG_FILES

        public static final String WRITE_DEBUG_FILES
        When set to true, the XML, XSLT and potential Exceptions occurring on a request to the appNG manager GUI are written to <platformRootPath>/debug
        See Also:
        Constant Field Values
      • REPOSITORY_DEFAULT_DIGEST

        public static final String REPOSITORY_DEFAULT_DIGEST
        The default digest for a published local application repository
        See Also:
        Constant Field Values
      • REPOSITORY_CERT

        public static final String REPOSITORY_CERT
        The certificate to use when verifying a signed remote repository (PEM format)
        See Also:
        Constant Field Values
      • REPOSITORY_SIGNATURE

        public static final String REPOSITORY_SIGNATURE
        The private key to use when signing a local published repository (PEM format)
        See Also:
        Constant Field Values
      • REPOSITORY_TRUSTSTORE

        public static final String REPOSITORY_TRUSTSTORE
        The truststore used when verifying a signed remote repository, using file://-protocol. If empty, the default $java.home/lib/security/cacerts is being used.
        See Also:
        Constant Field Values
      • REPOSITORY_TRUST_STORE_PASSWORD

        public static final String REPOSITORY_TRUST_STORE_PASSWORD
        The truststore's password
        See Also:
        Constant Field Values
      • REPOSITORY_VERIFY_SIGNATURE

        public static final String REPOSITORY_VERIFY_SIGNATURE
        When set to true, signed remote repositories are validated against the configured (or default) truststore.
        See Also:
        Constant Field Values
      • SESSION_FILTER

        public static final String SESSION_FILTER
        The regular expressions to match against the user-agent header for immediate discard of the session.
        See Also:
        Constant Field Values
      • XSS_ALLOWED_TAGS

        public static final String XSS_ALLOWED_TAGS
        A list of allowed HTML Tags, separated by '|', optionally followed by a space-separated list of allowed attributes.
        Example:
         h1|h2|a href class style|div align style
         
        See Also:
        Constant Field Values
      • WAIT_ON_SITE_SHUTDOWN

        public static final String WAIT_ON_SITE_SHUTDOWN
        When set to true, appNG waits until a Site has finished processing its requests before shutting it down.
        See Also:
        Constant Field Values
      • WAIT_TIME

        public static final String WAIT_TIME
        The time to wait (in a single waiting loop) for a Site to become available/to finish its requests (milliseconds).
        See Also:
        Constant Field Values
      • MAX_WAIT_TIME

        public static final String MAX_WAIT_TIME
        The overall maximum time to wait for a Site to become available/to finish its requests (milliseconds).
        See Also:
        Constant Field Values
      • KEYCLOAK_GROUP_CLAIM_NAME

        public static final String KEYCLOAK_GROUP_CLAIM_NAME
        The 'Token Claim Name' configured in the 'User Client Role'-mapper of the Keycloak client
        See Also:
        Constant Field Values
      • KEYCLOAK_GROUP_PREFIX

        public static final String KEYCLOAK_GROUP_PREFIX
        The 'Client Role prefix' configured in the 'User Client Role'-mapper of the Keycloak client
        See Also:
        Constant Field Values
      • KEYCLOAK_SECURITY_ROLE

        public static final String KEYCLOAK_SECURITY_ROLE
        The role configured in the Keycloak client, used as a security-role in web.xml
        See Also:
        Constant Field Values
      • MAX_LOGIN_ATTEMPTS

        public static final String MAX_LOGIN_ATTEMPTS
        The maximum number of failed login attempts before a Subject gets locked.
        See Also:
        Constant Field Values
    • Constructor Detail

      • Property

        public Property()