public class UserDefinedVirtualAttributeProvider extends VirtualAttributeProvider<UserDefinedVirtualAttributeCfg> implements ConfigurationChangeListener<UserDefinedVirtualAttributeCfg>
Note: We will not allow searches based only on user-defined virtual attributes.
Constructor and Description |
---|
UserDefinedVirtualAttributeProvider() |
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 |
getAttribute(Entry entry,
AttributeDescription attrDesc)
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.
|
isConfigurationAcceptable, isSearchable, processSearch
public void initializeVirtualAttributeProvider(UserDefinedVirtualAttributeCfg configuration) throws ConfigException, InitializationException
VirtualAttributeProvider
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()
VirtualAttributeProvider
finalizeVirtualAttributeProvider
in class VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>
public boolean isMultiValued()
VirtualAttributeProvider
isMultiValued
in class VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>
true
if this virtual attribute provider may generate multiple values, or false
if not.public Attribute getAttribute(Entry entry, AttributeDescription attrDesc)
VirtualAttributeProvider
getAttribute
in class VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>
entry
- The entry for which the values are to be generated.attrDesc
- the attribute description corresponding to this virtual attributenull
.public boolean isConfigurationChangeAcceptable(UserDefinedVirtualAttributeCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
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)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<UserDefinedVirtualAttributeCfg>
configuration
- The new configuration containing the changes.Copyright 2010-2022 ForgeRock AS.