Uses of Class
org.forgerock.am.cts.api.tokens.CoreTokenField
-
Packages that use CoreTokenField Package Description org.forgerock.am.cts.api.fields org.forgerock.am.cts.api.filter org.forgerock.am.cts.api.query org.forgerock.am.cts.api.tokens -
-
Uses of CoreTokenField in org.forgerock.am.cts.api.fields
Methods in org.forgerock.am.cts.api.fields with parameters of type CoreTokenField Modifier and Type Method Description static boolean
CoreTokenFieldTypes. isByteArray(CoreTokenField field)
static boolean
CoreTokenFieldTypes. isCalendar(CoreTokenField field)
static boolean
CoreTokenFieldTypes. isInteger(CoreTokenField field)
static boolean
CoreTokenFieldTypes. isMulti(CoreTokenField field)
static boolean
CoreTokenFieldTypes. isString(CoreTokenField field)
static void
CoreTokenFieldTypes. validateType(CoreTokenField field, Object value)
Validate the value matches the expected type for the given key.Method parameters in org.forgerock.am.cts.api.fields with type arguments of type CoreTokenField Modifier and Type Method Description static void
CoreTokenFieldTypes. validateTypes(Map<CoreTokenField,Object> types)
Validate a collection of key/value mappings. -
Uses of CoreTokenField in org.forgerock.am.cts.api.filter
Methods in org.forgerock.am.cts.api.filter that return types with arguments of type CoreTokenField Modifier and Type Method Description QueryFilter<CoreTokenField>
TokenFilter. getQuery()
Inspect the CoreTokenField, Object pairs that have been assigned as filters.Set<CoreTokenField>
TokenFilter. getReturnFields()
The current set of return fields.Methods in org.forgerock.am.cts.api.filter with parameters of type CoreTokenField Modifier and Type Method Description void
TokenFilter. addReturnAttribute(CoreTokenField field)
Assigns an attribute to be part of the return attributes.TokenFilterBuilder.FilterAttributeBuilder
TokenFilterBuilder.FilterAttributeBuilder. returnAttribute(CoreTokenField field)
If you only require the returned CTS Tokens to contains a subset of the standardvalues()
then this method allows the caller to specify the fields they would like in the returned CTS Tokens.TokenFilterBuilder
TokenFilterBuilder. returnAttribute(CoreTokenField field)
If you only require the returned CTS Tokens to contains a subset of the standardvalues()
then this method allows the caller to specify the fields they would like in the returned CTS Tokens.TokenFilterBuilder.FilterAttributeBuilder
TokenFilterBuilder.FilterAttributeBuilder. withAttribute(CoreTokenField field, Object value)
Filters the result CTS Tokens to only include those that have the matching attribute.TokenFilterBuilder.FilterAttributeBuilder
TokenFilterBuilder. withAttribute(CoreTokenField field, Object value)
Filters the result CTS Tokens to only include those that have the matching attribute.TokenFilterBuilder.FilterAttributeBuilder
TokenFilterBuilder.FilterAttributeBuilder. withPriorityAttribute(CoreTokenField field, Object value)
A variant ofTokenFilterBuilder.FilterAttributeBuilder.withAttribute(CoreTokenField, Object)
which changes the order of the filter arguments to allow the underlying backend to efficiently run the query.Method parameters in org.forgerock.am.cts.api.filter with type arguments of type CoreTokenField Modifier and Type Method Description void
TokenFilter. setQuery(QueryFilter<CoreTokenField> query)
Set the query component to the Filter.TokenFilterBuilder
TokenFilterBuilder. withQuery(QueryFilter<CoreTokenField> query)
Rather than building up the query using these builder methods, callers can define the entire query themselves. -
Uses of CoreTokenField in org.forgerock.am.cts.api.query
Methods in org.forgerock.am.cts.api.query that return types with arguments of type CoreTokenField Modifier and Type Method Description Collection<CoreTokenField>
PartialToken. getFields()
The fields that were included in this query.Methods in org.forgerock.am.cts.api.query with parameters of type CoreTokenField Modifier and Type Method Description <T> T
PartialToken. getValue(CoreTokenField field)
-
Uses of CoreTokenField in org.forgerock.am.cts.api.tokens
Methods in org.forgerock.am.cts.api.tokens that return CoreTokenField Modifier and Type Method Description static CoreTokenField
CoreTokenField. fromLDAPAttribute(String value)
Convert the field name into a CoreTokenField enumeration.static CoreTokenField
CoreTokenField. valueOf(String name)
Returns the enum constant of this type with the specified name.static CoreTokenField[]
CoreTokenField. values()
Returns an array containing the constants of this enum type, in the order they are declared.Methods in org.forgerock.am.cts.api.tokens that return types with arguments of type CoreTokenField Modifier and Type Method Description Collection<CoreTokenField>
Token. getAttributeNames()
The Token supports being accessed in a generic way allowing a caller to iterate over all fields that are assigned in this token.Map<CoreTokenField,Object>
TokenModifications. getModificationOfType(TokenModifications.TokenModificationType type)
Returns a map of the set of modifications listed under this modification type.Map<TokenModifications.TokenModificationType,Map<CoreTokenField,Object>>
TokenModifications. getModifications()
Returns a map of all the modifications in this object.Methods in org.forgerock.am.cts.api.tokens with parameters of type CoreTokenField Modifier and Type Method Description void
Token. clearAttribute(CoreTokenField field)
Clear a set attribute.<T> T
Token. getAttribute(CoreTokenField field)
Accessor for the CoreTokenField attributes.<T> Set<T>
Token. getMultiAttribute(CoreTokenField field)
Accessor for the multi-value CoreTokenField attributes.static boolean
Token. isFieldReadOnly(CoreTokenField field)
Trying to change a read-only field will trigger a runtime exception.<T> void
Token. setAttribute(CoreTokenField field, T value)
Mutator for the non-primary fields of the Token.<T> void
Token. setMultiAttribute(CoreTokenField field, T value)
Mutator for the fields of the Token.Method parameters in org.forgerock.am.cts.api.tokens with type arguments of type CoreTokenField Modifier and Type Method Description void
TokenModifications. addModifications(TokenModifications.TokenModificationType type, Map<CoreTokenField,Object> entry)
Add a modification to this token modification set.
-