Package org.forgerock.am.cts.api

Class CoreTokenConstants

java.lang.Object
org.forgerock.am.cts.api.CoreTokenConstants
public final class CoreTokenConstants extends Object
Responsible for collecting together all constants used in the Core Token Service.

  • Field Details

    • DEBUG_HEADER

      public static final String DEBUG_HEADER
      Debugging header, for all debug messages.
      See Also:

    • DEBUG_ASYNC_HEADER

      public static final String DEBUG_ASYNC_HEADER
      Debugging header, for all async processing debug messages.
      See Also:

    • CTS_DEBUG

      public static final String CTS_DEBUG
      Debug instance name for all CTS debugging.
      See Also:

    • CTS_MONITOR_DEBUG

      public static final String CTS_MONITOR_DEBUG
      Debug instance name for all CTS Monitor debugging
      See Also:

    • CTS_REAPER_DEBUG

      public static final String CTS_REAPER_DEBUG
      Debug instance name for the CTS Reaper.
      See Also:

    • CTS_ASYNC_DEBUG

      public static final String CTS_ASYNC_DEBUG
      Debug instance name for the CTS Async processing.
      See Also:

    • SYS_PROPERTY_EXPIRED_SEARCH_LIMIT

      public static final String SYS_PROPERTY_EXPIRED_SEARCH_LIMIT
      Globals public Constants, so not to pollute entire product.
      See Also:

    • DEBUG_NAME

      public static final String DEBUG_NAME
      See Also:

    • OBJECT_CLASS

      public static final String OBJECT_CLASS
      See Also:

    • FR_CORE_TOKEN

      public static final String FR_CORE_TOKEN
      See Also:

    • CTS_SMS_CONFIGURATION

      public static final String CTS_SMS_CONFIGURATION
      The name of the general purpose worker pool for the CTS.
      See Also:

    • CTS_STORE_LOCATION

      public static final String CTS_STORE_LOCATION
      The CTS token store can be either embedded or external. If external then more information is needed to connect.
      See Also:

    • CTS_ROOT_SUFFIX

      public static final String CTS_ROOT_SUFFIX
      The fully qualified name of the suffix where the tokens will be created.
      See Also:

    • CTS_STORE_SSL_ENABLED

      public static final String CTS_STORE_SSL_ENABLED
      Enable/disable SSL for the CTS token store connections.
      See Also:

    • CTS_STORE_STARTTLS_ENABLED

      public static final String CTS_STORE_STARTTLS_ENABLED
      Enable/disable Start TLS for the CTS token store connections.
      See Also:

    • CTS_STORE_MTLS_ENABLED

      public static final String CTS_STORE_MTLS_ENABLED
      Enable/disable mTLS for the CTS token store connections.
      See Also:

    • CTS_STORE_HOSTNAME

      public static final String CTS_STORE_HOSTNAME
      Hostname where the CTS token store may be reached. This may point to a load balancer.
      See Also:

    • CTS_STORE_USERNAME

      public static final String CTS_STORE_USERNAME
      Username for the token store connection.
      See Also:

    • CTS_STORE_PASSWORD

      public static final String CTS_STORE_PASSWORD
      Password for connecting to the token store.
      See Also:

    • CTS_UMA_AUDIT_STORE_PASSWORD

      public static final String CTS_UMA_AUDIT_STORE_PASSWORD
      Password for the uma audit store
      See Also:

    • CTS_RESOURCE_SETS_STORE_PASSWORD

      public static final String CTS_RESOURCE_SETS_STORE_PASSWORD
      Password for the resource sets store
      See Also:

    • CTS_UMA_PENDING_REQUESTS_STORE_PASSWORD

      public static final String CTS_UMA_PENDING_REQUESTS_STORE_PASSWORD
      Password for the uma pending requests store
      See Also:

    • CTS_UMA_LABELS_STORE_PASSWORD

      public static final String CTS_UMA_LABELS_STORE_PASSWORD
      Password for the uma labels store
      See Also:

    • CTS_STORE_MAX_CONNECTIONS

      public static final String CTS_STORE_MAX_CONNECTIONS
      Maximum number of connections to the token store.
      See Also:

    • CTS_STORE_PAGE_SIZE

      public static final String CTS_STORE_PAGE_SIZE
      Page size to use with LDAP query/partial query operations.
      See Also:

    • CTS_STORE_PAGE_SIZE_DEFAULT

      public static final int CTS_STORE_PAGE_SIZE_DEFAULT
      Default page size.
      See Also:

    • CTS_STORE_VLV_PAGE_SIZE

      public static final String CTS_STORE_VLV_PAGE_SIZE
      Page size to use with LDAP VLV operations.
      See Also:

    • CTS_STORE_VLV_PAGE_SIZE_DEFAULT

      public static final int CTS_STORE_VLV_PAGE_SIZE_DEFAULT
      Default VLV page size.
      See Also:

    • ID

      public static final String ID
      Token ID constant.
      See Also:

    • CTS_STORE_MAX_CONNECTIONS_DEFAULT

      public static final String CTS_STORE_MAX_CONNECTIONS_DEFAULT
      Default maximum number of connections to the token store.
      See Also:

    • CTS_STORE_AFFINITY_ENABLED

      public static final String CTS_STORE_AFFINITY_ENABLED
      Enable/disable the OpenDJ SDK's affinity based load balancing feature.
      See Also:

    • OBJECT_MAPPER

      public static final String OBJECT_MAPPER
      Binding constant for the CTS Jackson Object Mapper.
      See Also:

    • CTS_REAPER_ENABLED

      public static final String CTS_REAPER_ENABLED
      Whether the reaper is enabled.
      See Also:

    • CTS_REAPER_CACHE_SIZE

      public static final String CTS_REAPER_CACHE_SIZE
      The maximum number of tokens to hold in memory for deletion.
      See Also:

    • CTS_REAPER_CACHE_DELETION_FREQUENCY_MILLISECONDS

      public static final String CTS_REAPER_CACHE_DELETION_FREQUENCY_MILLISECONDS
      How often to poll the Reaper cache for tokens that have expired and delete them.
      See Also:

    • CTS_REAPER_SEARCH_MAX_RESULTS

      public static final String CTS_REAPER_SEARCH_MAX_RESULTS
      Controls the total number of tokens that will be cleaned by the Search Reaper each iteration.

      The Search based Reaper will periodically search for tokens and remove expired tokens found. This occurs on a periodic basis determined by the CTS_REAPER_SEARCH_DELETION_FREQUENCY_MILLISECONDS period. When the search takes place, the total number of tokens cleaned up in the search is controlled by this value.

      See Also:

    • CTS_REAPER_SEARCH_GRACE_PERIOD_MILLISECONDS

      public static final String CTS_REAPER_SEARCH_GRACE_PERIOD_MILLISECONDS
      A duration that is added to token expiry dates to delay reaping via search.

      To allow the reaper time to delete the token using its cache, the grace period should be larger than CTS_REAPER_CACHE_DELETION_FREQUENCY_MILLISECONDS; deleting from the cache is preferred as it avoids expensive searches against the CTS persistence store and avoids multiple servers attempting to delete the same token.

      See Also:

    • CTS_REAPER_SEARCH_DELETION_FREQUENCY_MILLISECONDS

      public static final String CTS_REAPER_SEARCH_DELETION_FREQUENCY_MILLISECONDS
      How often to perform a search for expired tokens in the CTS persistence store.
      See Also:

    • CTS_TTL_SUPPORT_ENABLED

      public static final String CTS_TTL_SUPPORT_ENABLED
      Whether TTL support is enabled.
      See Also:

    • CTS_TTL_SUPPORT_TOKEN_TYPE_EXCLUSION_LIST

      public static final String CTS_TTL_SUPPORT_TOKEN_TYPE_EXCLUSION_LIST
      Which token types are blacklisted from TTL support.
      See Also: