Package org.forgerock.am.cts
Interface CoreTokenConfig
-
public interface CoreTokenConfig
Represents any configuration required for the Core Token Service.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getPageSize()
The number of entries to return in a single page of queried results.int
getReaperCacheDeletionFrequencyMilliseconds()
int
getReaperCacheSize()
Defines the maximum number of tokens to track for deletion by the CTS reaper.int
getReaperSearchDeletionFrequencyMilliseconds()
int
getReaperSearchExpiryGracePeriodMilliseconds()
int
getReaperSearchMaxResults()
int
getVlvPageSize()
The number of entries to return in a single page of VLV-queried results.boolean
isAttributeNamesCompressed()
boolean
isCaseSensitiveUserId()
boolean
isCoreTokenResourceEnabled()
boolean
isReaperEnabled()
Indicates whether AM has been configured for Token Reaper or not.boolean
isTokenCompressed()
boolean
isTokenEncrypted()
boolean
isTtlSupportEnabled()
Indicates whether the DS TTL Support function has been enabled.boolean
shouldSupportTtl(TokenType tokenType)
Indicates whether the provided token type should include ttl support in the token.Set<TokenType>
ttlSupportTokenTypeBlacklist()
When theisTtlSupportEnabled()
feature is enabled, the DS TTL feature will be used to perform automatic cleanup of persisted entries.
-
-
-
Method Detail
-
getReaperCacheDeletionFrequencyMilliseconds
int getReaperCacheDeletionFrequencyMilliseconds()
- Returns:
- how often to poll the reaper cache for expired tokens, in milliseconds.
-
getReaperCacheSize
int getReaperCacheSize()
Defines the maximum number of tokens to track for deletion by the CTS reaper.- Returns:
- size of cache
-
getPageSize
int getPageSize()
The number of entries to return in a single page of queried results. If0
, pagination will not be used and all results will be returned in a single page, if possible.- Returns:
- page size
-
getVlvPageSize
int getVlvPageSize()
The number of entries to return in a single page of VLV-queried results.- Returns:
- page size
-
isCaseSensitiveUserId
boolean isCaseSensitiveUserId()
- Returns:
- True if the User Id is case sensitive.
-
getReaperSearchExpiryGracePeriodMilliseconds
int getReaperSearchExpiryGracePeriodMilliseconds()
- Returns:
- The time period in milliseconds after which an expired token will be deleted via the search.
-
getReaperSearchDeletionFrequencyMilliseconds
int getReaperSearchDeletionFrequencyMilliseconds()
- Returns:
- The period in milliseconds for how often the clean up thread of the Core Token Service should run to check for expired Tokens.
-
isCoreTokenResourceEnabled
boolean isCoreTokenResourceEnabled()
-
isTokenEncrypted
boolean isTokenEncrypted()
- Returns:
- True if the Binary object stored for each Token should be encrypted by the Core Token Service.
-
isTokenCompressed
boolean isTokenCompressed()
- Returns:
- True if the tokens within the Core Token Service can be compressed. False is the default.
-
isAttributeNamesCompressed
boolean isAttributeNamesCompressed()
- Returns:
- True if The Token Attribute Names should be compressed as well. False by default.
-
getReaperSearchMaxResults
int getReaperSearchMaxResults()
- Returns:
- The LDAP Query Page size in Tokens that will be deleted by the CTS Reaper.
-
isReaperEnabled
boolean isReaperEnabled()
Indicates whether AM has been configured for Token Reaper or not. When enabled, theorg.forgerock.am.cts.reaper.CachedTokenReaper
andorg.forgerock.am.cts.reaper.SearchTokenReaper
will be operational and will perform periodic token cleanup.- Returns:
true
indicates the reaper is enabled.
-
isTtlSupportEnabled
boolean isTtlSupportEnabled()
Indicates whether the DS TTL Support function has been enabled. When this is enabled, AM will modify tokens stored in the persistent layer to make use of the DS TTL feature.- Returns:
true
indicates this feature is enabled.
-
ttlSupportTokenTypeBlacklist
Set<TokenType> ttlSupportTokenTypeBlacklist()
When theisTtlSupportEnabled()
feature is enabled, the DS TTL feature will be used to perform automatic cleanup of persisted entries. If there are any tokens which should not be cleaned up using this process, then they must be included in this set ofTokenType
.- Returns:
- A non null, possibly empty set of
TokenType
which should be excluded from TTL based cleanup.
-
shouldSupportTtl
boolean shouldSupportTtl(TokenType tokenType)
Indicates whether the provided token type should include ttl support in the token.- Parameters:
tokenType
- the token type- Returns:
- true if the token should include ttl support
-
-