Record Class Key

java.lang.Object
java.lang.Record
is.galia.config.Key
public record Key(String key, boolean isPublic) extends Record

Application-defined configuration key.

Plugins can define their own configuration keys. Although they cannot be values of this enum, they can be strings which can be retrieved by the string accessor overloads of Configuration.

Adding a key

  1. Add a value for it here.
  2. Add it to the sample config file.
  3. Document the addition in the upgrade guide.

  • Field Details

    • ACCESS_LOG_CONSOLEAPPENDER_ENABLED

      public static final Key ACCESS_LOG_CONSOLEAPPENDER_ENABLED

    • ACCESS_LOG_FILEAPPENDER_ENABLED

      public static final Key ACCESS_LOG_FILEAPPENDER_ENABLED

    • ACCESS_LOG_FILEAPPENDER_PATHNAME

      public static final Key ACCESS_LOG_FILEAPPENDER_PATHNAME

    • ACCESS_LOG_ROLLINGFILEAPPENDER_ENABLED

      public static final Key ACCESS_LOG_ROLLINGFILEAPPENDER_ENABLED

    • ACCESS_LOG_ROLLINGFILEAPPENDER_PATHNAME

      public static final Key ACCESS_LOG_ROLLINGFILEAPPENDER_PATHNAME

    • ACCESS_LOG_ROLLINGFILEAPPENDER_POLICY

      public static final Key ACCESS_LOG_ROLLINGFILEAPPENDER_POLICY

    • ACCESS_LOG_ROLLINGFILEAPPENDER_FILENAME_PATTERN

      public static final Key ACCESS_LOG_ROLLINGFILEAPPENDER_FILENAME_PATTERN

    • ACCESS_LOG_ROLLINGFILEAPPENDER_MAX_HISTORY

      public static final Key ACCESS_LOG_ROLLINGFILEAPPENDER_MAX_HISTORY

    • ACCESS_LOG_SYSLOGAPPENDER_ENABLED

      public static final Key ACCESS_LOG_SYSLOGAPPENDER_ENABLED

    • ACCESS_LOG_SYSLOGAPPENDER_HOST

      public static final Key ACCESS_LOG_SYSLOGAPPENDER_HOST

    • ACCESS_LOG_SYSLOGAPPENDER_PORT

      public static final Key ACCESS_LOG_SYSLOGAPPENDER_PORT

    • ACCESS_LOG_SYSLOGAPPENDER_FACILITY

      public static final Key ACCESS_LOG_SYSLOGAPPENDER_FACILITY

    • API_ENABLED

      public static final Key API_ENABLED

    • API_SECRET

      public static final Key API_SECRET

    • API_USERNAME

      public static final Key API_USERNAME

    • APPLICATION_LOG_CONSOLEAPPENDER_COLOR

      public static final Key APPLICATION_LOG_CONSOLEAPPENDER_COLOR

    • APPLICATION_LOG_CONSOLEAPPENDER_ENABLED

      public static final Key APPLICATION_LOG_CONSOLEAPPENDER_ENABLED

    • APPLICATION_LOG_CONSOLEAPPENDER_FORMAT

      public static final Key APPLICATION_LOG_CONSOLEAPPENDER_FORMAT

    • APPLICATION_LOG_FILEAPPENDER_ENABLED

      public static final Key APPLICATION_LOG_FILEAPPENDER_ENABLED

    • APPLICATION_LOG_FILEAPPENDER_FORMAT

      public static final Key APPLICATION_LOG_FILEAPPENDER_FORMAT

    • APPLICATION_LOG_FILEAPPENDER_PATHNAME

      public static final Key APPLICATION_LOG_FILEAPPENDER_PATHNAME

    • APPLICATION_LOG_LEVEL

      public static final Key APPLICATION_LOG_LEVEL

    • APPLICATION_LOG_LOGSTASHAPPENDER_ENABLED

      public static final Key APPLICATION_LOG_LOGSTASHAPPENDER_ENABLED

    • APPLICATION_LOG_LOGSTASHAPPENDER_HOST

      public static final Key APPLICATION_LOG_LOGSTASHAPPENDER_HOST

    • APPLICATION_LOG_LOGSTASHAPPENDER_PORT

      public static final Key APPLICATION_LOG_LOGSTASHAPPENDER_PORT

    • APPLICATION_LOG_LOGSTASHAPPENDER_PROTOCOL

      public static final Key APPLICATION_LOG_LOGSTASHAPPENDER_PROTOCOL

    • APPLICATION_LOG_LOGSTASHAPPENDER_SSL

      public static final Key APPLICATION_LOG_LOGSTASHAPPENDER_SSL

    • APPLICATION_LOG_ROLLINGFILEAPPENDER_ENABLED

      public static final Key APPLICATION_LOG_ROLLINGFILEAPPENDER_ENABLED

    • APPLICATION_LOG_ROLLINGFILEAPPENDER_FORMAT

      public static final Key APPLICATION_LOG_ROLLINGFILEAPPENDER_FORMAT

    • APPLICATION_LOG_ROLLINGFILEAPPENDER_PATHNAME

      public static final Key APPLICATION_LOG_ROLLINGFILEAPPENDER_PATHNAME

    • APPLICATION_LOG_ROLLINGFILEAPPENDER_POLICY

      public static final Key APPLICATION_LOG_ROLLINGFILEAPPENDER_POLICY

    • APPLICATION_LOG_ROLLINGFILEAPPENDER_FILENAME_PATTERN

      public static final Key APPLICATION_LOG_ROLLINGFILEAPPENDER_FILENAME_PATTERN

    • APPLICATION_LOG_ROLLINGFILEAPPENDER_MAX_HISTORY

      public static final Key APPLICATION_LOG_ROLLINGFILEAPPENDER_MAX_HISTORY

    • APPLICATION_LOG_SYSLOGAPPENDER_ENABLED

      public static final Key APPLICATION_LOG_SYSLOGAPPENDER_ENABLED

    • APPLICATION_LOG_SYSLOGAPPENDER_HOST

      public static final Key APPLICATION_LOG_SYSLOGAPPENDER_HOST

    • APPLICATION_LOG_SYSLOGAPPENDER_PORT

      public static final Key APPLICATION_LOG_SYSLOGAPPENDER_PORT

    • APPLICATION_LOG_SYSLOGAPPENDER_FACILITY

      public static final Key APPLICATION_LOG_SYSLOGAPPENDER_FACILITY

    • ARTIFACT_REPOSITORY_BASE_URI

      public static final Key ARTIFACT_REPOSITORY_BASE_URI
      For development only; not present in the sample config file.

    • BASE_URI

      public static final Key BASE_URI

    • CACHE_SERVER_EVICT_MISSING

      public static final Key CACHE_SERVER_EVICT_MISSING

    • CACHE_SERVER_RESOLVE_FIRST

      public static final Key CACHE_SERVER_RESOLVE_FIRST

    • CACHE_WORKER_ENABLED

      public static final Key CACHE_WORKER_ENABLED

    • CACHE_WORKER_INTERVAL

      public static final Key CACHE_WORKER_INTERVAL

    • CHUNK_CACHE_ENABLED

      public static final Key CHUNK_CACHE_ENABLED

    • CHUNK_CACHE_MAX_SIZE

      public static final Key CHUNK_CACHE_MAX_SIZE

    • CLIENT_CACHE_ENABLED

      public static final Key CLIENT_CACHE_ENABLED

    • CLIENT_CACHE_MAX_AGE

      public static final Key CLIENT_CACHE_MAX_AGE

    • CLIENT_CACHE_MUST_REVALIDATE

      public static final Key CLIENT_CACHE_MUST_REVALIDATE

    • CLIENT_CACHE_NO_CACHE

      public static final Key CLIENT_CACHE_NO_CACHE

    • CLIENT_CACHE_NO_STORE

      public static final Key CLIENT_CACHE_NO_STORE

    • CLIENT_CACHE_NO_TRANSFORM

      public static final Key CLIENT_CACHE_NO_TRANSFORM

    • CLIENT_CACHE_PRIVATE

      public static final Key CLIENT_CACHE_PRIVATE

    • CLIENT_CACHE_PROXY_REVALIDATE

      public static final Key CLIENT_CACHE_PROXY_REVALIDATE

    • CLIENT_CACHE_PUBLIC

      public static final Key CLIENT_CACHE_PUBLIC

    • CLIENT_CACHE_SHARED_MAX_AGE

      public static final Key CLIENT_CACHE_SHARED_MAX_AGE

    • CUSTOMER_KEY

      public static final Key CUSTOMER_KEY

    • DECODER_FORMATS

      public static final Key DECODER_FORMATS

    • DEEPZOOM_ENDPOINT_ENABLED

      public static final Key DEEPZOOM_ENDPOINT_ENABLED

    • DEEPZOOM_ENDPOINT_PATH

      public static final Key DEEPZOOM_ENDPOINT_PATH

    • DEEPZOOM_FORMAT

      public static final Key DEEPZOOM_FORMAT

    • DEEPZOOM_MIN_TILE_SIZE

      public static final Key DEEPZOOM_MIN_TILE_SIZE

    • DELEGATE_ENABLED

      public static final Key DELEGATE_ENABLED
      For testing only; not present in the sample config file.

    • ENCODER_FORMATS

      public static final Key ENCODER_FORMATS

    • ENCODER_JPEGENCODER_PROGRESSIVE

      public static final Key ENCODER_JPEGENCODER_PROGRESSIVE

    • ENCODER_JPEGENCODER_QUALITY

      public static final Key ENCODER_JPEGENCODER_QUALITY

    • ENCODER_TIFFENCODER_COMPRESSION

      public static final Key ENCODER_TIFFENCODER_COMPRESSION

    • ERROR_LOG_FILEAPPENDER_ENABLED

      public static final Key ERROR_LOG_FILEAPPENDER_ENABLED

    • ERROR_LOG_FILEAPPENDER_FORMAT

      public static final Key ERROR_LOG_FILEAPPENDER_FORMAT

    • ERROR_LOG_FILEAPPENDER_PATHNAME

      public static final Key ERROR_LOG_FILEAPPENDER_PATHNAME

    • ERROR_LOG_ROLLINGFILEAPPENDER_ENABLED

      public static final Key ERROR_LOG_ROLLINGFILEAPPENDER_ENABLED

    • ERROR_LOG_ROLLINGFILEAPPENDER_FORMAT

      public static final Key ERROR_LOG_ROLLINGFILEAPPENDER_FORMAT

    • ERROR_LOG_ROLLINGFILEAPPENDER_PATHNAME

      public static final Key ERROR_LOG_ROLLINGFILEAPPENDER_PATHNAME

    • ERROR_LOG_ROLLINGFILEAPPENDER_POLICY

      public static final Key ERROR_LOG_ROLLINGFILEAPPENDER_POLICY

    • ERROR_LOG_ROLLINGFILEAPPENDER_FILENAME_PATTERN

      public static final Key ERROR_LOG_ROLLINGFILEAPPENDER_FILENAME_PATTERN

    • ERROR_LOG_ROLLINGFILEAPPENDER_MAX_HISTORY

      public static final Key ERROR_LOG_ROLLINGFILEAPPENDER_MAX_HISTORY

    • FILESYSTEMCACHE_DIRECTORY_DEPTH

      public static final Key FILESYSTEMCACHE_DIRECTORY_DEPTH

    • FILESYSTEMCACHE_DIRECTORY_NAME_LENGTH

      public static final Key FILESYSTEMCACHE_DIRECTORY_NAME_LENGTH

    • FILESYSTEMCACHE_PATHNAME

      public static final Key FILESYSTEMCACHE_PATHNAME

    • FILESYSTEMSOURCE_LOOKUP_STRATEGY

      public static final Key FILESYSTEMSOURCE_LOOKUP_STRATEGY

    • FILESYSTEMSOURCE_PATH_PREFIX

      public static final Key FILESYSTEMSOURCE_PATH_PREFIX

    • FILESYSTEMSOURCE_PATH_SUFFIX

      public static final Key FILESYSTEMSOURCE_PATH_SUFFIX

    • HEALTH_DEPENDENCY_CHECK

      public static final Key HEALTH_DEPENDENCY_CHECK

    • HEALTH_ENDPOINT_ENABLED

      public static final Key HEALTH_ENDPOINT_ENABLED

    • HEAPCACHE_TARGET_SIZE

      public static final Key HEAPCACHE_TARGET_SIZE

    • HEAP_INFO_CACHE_ENABLED

      public static final Key HEAP_INFO_CACHE_ENABLED

    • HTTP_ACCEPT_QUEUE_LIMIT

      public static final Key HTTP_ACCEPT_QUEUE_LIMIT

    • HTTP_CLIENT_IMPLEMENTATION

      public static final Key HTTP_CLIENT_IMPLEMENTATION

    • HTTP_ENABLED

      public static final Key HTTP_ENABLED

    • HTTP_HOST

      public static final Key HTTP_HOST

    • HTTP_IDLE_TIMEOUT

      public static final Key HTTP_IDLE_TIMEOUT

    • HTTP_MAX_THREADS

      public static final Key HTTP_MAX_THREADS

    • HTTP_MIN_THREADS

      public static final Key HTTP_MIN_THREADS

    • HTTP_PORT

      public static final Key HTTP_PORT

    • HTTPSOURCE_ALLOW_INSECURE

      public static final Key HTTPSOURCE_ALLOW_INSECURE

    • HTTPSOURCE_BASIC_AUTH_SECRET

      public static final Key HTTPSOURCE_BASIC_AUTH_SECRET

    • HTTPSOURCE_BASIC_AUTH_USERNAME

      public static final Key HTTPSOURCE_BASIC_AUTH_USERNAME

    • HTTPSOURCE_CHUNKING_ENABLED

      public static final Key HTTPSOURCE_CHUNKING_ENABLED

    • HTTPSOURCE_CHUNK_SIZE

      public static final Key HTTPSOURCE_CHUNK_SIZE

    • HTTPSOURCE_HTTP_PROXY_HOST

      public static final Key HTTPSOURCE_HTTP_PROXY_HOST

    • HTTPSOURCE_HTTP_PROXY_PORT

      public static final Key HTTPSOURCE_HTTP_PROXY_PORT

    • HTTPSOURCE_LOOKUP_STRATEGY

      public static final Key HTTPSOURCE_LOOKUP_STRATEGY

    • HTTPSOURCE_REQUEST_TIMEOUT

      public static final Key HTTPSOURCE_REQUEST_TIMEOUT

    • HTTPSOURCE_SEND_HEAD_REQUESTS

      public static final Key HTTPSOURCE_SEND_HEAD_REQUESTS

    • HTTPSOURCE_URL_PREFIX

      public static final Key HTTPSOURCE_URL_PREFIX

    • HTTPSOURCE_URL_SUFFIX

      public static final Key HTTPSOURCE_URL_SUFFIX

    • HTTPS_ENABLED

      public static final Key HTTPS_ENABLED

    • HTTPS_HOST

      public static final Key HTTPS_HOST

    • HTTPS_KEY_PASSWORD

      public static final Key HTTPS_KEY_PASSWORD

    • HTTPS_KEY_STORE_PASSWORD

      public static final Key HTTPS_KEY_STORE_PASSWORD

    • HTTPS_KEY_STORE_PATH

      public static final Key HTTPS_KEY_STORE_PATH

    • HTTPS_KEY_STORE_TYPE

      public static final Key HTTPS_KEY_STORE_TYPE

    • HTTPS_PORT

      public static final Key HTTPS_PORT

    • IIIF_1_ENDPOINT_ENABLED

      public static final Key IIIF_1_ENDPOINT_ENABLED

    • IIIF_1_ENDPOINT_PATH

      public static final Key IIIF_1_ENDPOINT_PATH

    • IIIF_2_ENDPOINT_ENABLED

      public static final Key IIIF_2_ENDPOINT_ENABLED

    • IIIF_2_ENDPOINT_PATH

      public static final Key IIIF_2_ENDPOINT_PATH

    • IIIF_3_ENDPOINT_ENABLED

      public static final Key IIIF_3_ENDPOINT_ENABLED

    • IIIF_3_ENDPOINT_PATH

      public static final Key IIIF_3_ENDPOINT_PATH

    • IIIF_MIN_SIZE

      public static final Key IIIF_MIN_SIZE

    • IIIF_MIN_TILE_SIZE

      public static final Key IIIF_MIN_TILE_SIZE

    • IIIF_RESTRICT_TO_SIZES

      public static final Key IIIF_RESTRICT_TO_SIZES

    • INFO_CACHE

      public static final Key INFO_CACHE

    • INFO_CACHE_ENABLED

      public static final Key INFO_CACHE_ENABLED

    • INFO_CACHE_TTL

      public static final Key INFO_CACHE_TTL

    • LOG_ERROR_RESPONSES

      public static final Key LOG_ERROR_RESPONSES

    • MAX_PIXELS

      public static final Key MAX_PIXELS

    • MAX_SCALE

      public static final Key MAX_SCALE

    • META_IDENTIFIER_TRANSFORMER

      public static final Key META_IDENTIFIER_TRANSFORMER

    • OVERLAY_ENABLED

      public static final Key OVERLAY_ENABLED

    • OVERLAY_IMAGE

      public static final Key OVERLAY_IMAGE

    • OVERLAY_INSET

      public static final Key OVERLAY_INSET

    • OVERLAY_OUTPUT_HEIGHT_THRESHOLD

      public static final Key OVERLAY_OUTPUT_HEIGHT_THRESHOLD

    • OVERLAY_OUTPUT_WIDTH_THRESHOLD

      public static final Key OVERLAY_OUTPUT_WIDTH_THRESHOLD

    • OVERLAY_POSITION

      public static final Key OVERLAY_POSITION

    • OVERLAY_STRATEGY

      public static final Key OVERLAY_STRATEGY

    • OVERLAY_STRING_BACKGROUND_COLOR

      public static final Key OVERLAY_STRING_BACKGROUND_COLOR

    • OVERLAY_STRING_COLOR

      public static final Key OVERLAY_STRING_COLOR

    • OVERLAY_STRING_FONT

      public static final Key OVERLAY_STRING_FONT

    • OVERLAY_STRING_FONT_MIN_SIZE

      public static final Key OVERLAY_STRING_FONT_MIN_SIZE

    • OVERLAY_STRING_FONT_SIZE

      public static final Key OVERLAY_STRING_FONT_SIZE

    • OVERLAY_STRING_FONT_WEIGHT

      public static final Key OVERLAY_STRING_FONT_WEIGHT

    • OVERLAY_STRING_GLYPH_SPACING

      public static final Key OVERLAY_STRING_GLYPH_SPACING

    • OVERLAY_STRING_STRING

      public static final Key OVERLAY_STRING_STRING

    • OVERLAY_STRING_STROKE_COLOR

      public static final Key OVERLAY_STRING_STROKE_COLOR

    • OVERLAY_STRING_STROKE_WIDTH

      public static final Key OVERLAY_STRING_STROKE_WIDTH

    • OVERLAY_TYPE

      public static final Key OVERLAY_TYPE

    • PROCESSOR_BACKGROUND_COLOR

      public static final Key PROCESSOR_BACKGROUND_COLOR

    • PROCESSOR_DOWNSCALE_LINEAR

      public static final Key PROCESSOR_DOWNSCALE_LINEAR

    • PROCESSOR_DOWNSCALE_FILTER

      public static final Key PROCESSOR_DOWNSCALE_FILTER

    • PROCESSOR_SHARPEN

      public static final Key PROCESSOR_SHARPEN

    • PROCESSOR_UPSCALE_FILTER

      public static final Key PROCESSOR_UPSCALE_FILTER

    • PROCESSOR_USE_EMBEDDED_THUMBNAILS

      public static final Key PROCESSOR_USE_EMBEDDED_THUMBNAILS

    • REPORT_ERRORS

      public static final Key REPORT_ERRORS
      Not present in the sample config file.

    • SOURCE_DELEGATE

      public static final Key SOURCE_DELEGATE

    • SOURCE_STATIC

      public static final Key SOURCE_STATIC

    • SLASH_SUBSTITUTE

      public static final Key SLASH_SUBSTITUTE

    • STANDARD_META_IDENTIFIER_TRANSFORMER_DELIMITER

      public static final Key STANDARD_META_IDENTIFIER_TRANSFORMER_DELIMITER

    • TEMP_PATHNAME

      public static final Key TEMP_PATHNAME

    • VARIANT_CACHE

      public static final Key VARIANT_CACHE

    • VARIANT_CACHE_ENABLED

      public static final Key VARIANT_CACHE_ENABLED

    • VARIANT_CACHE_TTL

      public static final Key VARIANT_CACHE_TTL

  • Constructor Details

    • Key

      public Key(String key, boolean isPublic)
      Creates an instance of a Key record class.
      Parameters:
      key - the value for the key record component
      isPublic - the value for the isPublic record component

  • Method Details

    • values

      public static Key[] values()
      Returns:
      All application-defined keys. Plugins may define their own keys which will not be included.

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • key

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • isPublic

      public boolean isPublic()
      Returns the value of the isPublic record component.
      Returns:
      the value of the isPublic record component