public class UserDefinedVirtualAttributeProvider extends VirtualAttributeProvider<UserDefinedVirtualAttributeCfg> implements ConfigurationChangeListener<UserDefinedVirtualAttributeCfg>
| Constructor and Description |
|---|
UserDefinedVirtualAttributeProvider()
Creates a new instance of this member virtual attribute provider.
|
| Modifier and Type | Method and Description |
|---|---|
ConfigChangeResult |
applyConfigurationChange(UserDefinedVirtualAttributeCfg configuration)
Applies the configuration changes to this change listener.
|
void |
finalizeVirtualAttributeProvider()
Performs any finalization that may be necessary whenever this
virtual attribute provider is taken out of service.
|
Attribute |
getValues(Entry entry,
VirtualAttributeRule rule)
Generates an unmodifiable attribute with the values for the provided entry.
|
void |
initializeVirtualAttributeProvider(UserDefinedVirtualAttributeCfg configuration)
Initializes this virtual attribute based on the information in
the provided configuration entry.
|
boolean |
isConfigurationChangeAcceptable(UserDefinedVirtualAttributeCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is
acceptable to this change listener.
|
boolean |
isMultiValued()
Indicates whether this virtual attribute provider may generate
multiple values.
|
boolean |
isSearchable(VirtualAttributeRule rule,
SearchOperation searchOperation,
boolean isPreIndexed)
Indicates whether this attribute may be included in search
filters as part of the criteria for locating entries.
|
void |
processSearch(VirtualAttributeRule rule,
SearchOperation searchOperation)
Processes the provided search operation in which the search
criteria includes an operation targeted at this virtual
attribute.
|
approximatelyEqualTo, greaterThanOrEqualTo, hasAllValues, hasValue, hasValue, isConfigurationAcceptable, lessThanOrEqualTo, matchesEqualityAssertion, matchesSubstringpublic UserDefinedVirtualAttributeProvider()
public void initializeVirtualAttributeProvider(UserDefinedVirtualAttributeCfg configuration) throws ConfigException, InitializationException
initializeVirtualAttributeProvider in class VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>configuration - The configuration to use to initialize
this virtual attribute provider.ConfigException - If an unrecoverable problem arises in
the process of performing the
initialization.InitializationException - If a problem occurs during
initialization that is not
related to the server
configuration.public void finalizeVirtualAttributeProvider()
finalizeVirtualAttributeProvider in class VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>public boolean isMultiValued()
isMultiValued in class VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>true if this virtual attribute provider may
generate multiple values, or false if not.public Attribute getValues(Entry entry, VirtualAttributeRule rule)
getValues in class VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>entry - The entry for which the values are to be generated.rule - The virtual attribute rule which defines the constraints
for the virtual attribute.null.public boolean isSearchable(VirtualAttributeRule rule, SearchOperation searchOperation, boolean isPreIndexed)
isSearchable in class VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>rule - The virtual attribute rule which defines
the constraints for the virtual
attribute.searchOperation - The search operation for which to make
the determination.isPreIndexed - Indicates if we expect the search on the virtual
attribute to be faster than an index search.true if this attribute may be included in search
filters, or false if not.public void processSearch(VirtualAttributeRule rule, SearchOperation searchOperation)
isSearchable returns true and it is not possible to
construct a manageable candidate list by processing other
elements of the search criteria.processSearch in class VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>rule - The virtual attribute rule which defines
the constraints for the virtual
attribute.searchOperation - The search operation to be processed.public boolean isConfigurationChangeAcceptable(UserDefinedVirtualAttributeCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable in interface ConfigurationChangeListener<UserDefinedVirtualAttributeCfg>configuration - The new configuration containing the changes.unacceptableReasons - A list that can be used to hold messages about why the
provided configuration is not acceptable.true if the proposed change is
acceptable, or false if it is not.public ConfigChangeResult applyConfigurationChange(UserDefinedVirtualAttributeCfg configuration)
applyConfigurationChange in interface ConfigurationChangeListener<UserDefinedVirtualAttributeCfg>configuration - The new configuration containing the changes.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.