public final class EntityTagVirtualAttributeProvider extends VirtualAttributeProvider<EntityTagVirtualAttributeCfg> implements ConfigurationChangeListener<EntityTagVirtualAttributeCfg>
The entity tag may be used by clients, in conjunction with the assertion control, for optimistic concurrency control, as a way to help prevent simultaneous updates of an entry from conflicting with each other.
Note: etags cannot be searched since there is no way to determine which entry is associated with a particular ETag.
Constructor and Description |
---|
EntityTagVirtualAttributeProvider() |
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(EntityTagVirtualAttributeCfg 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 attributeDescription)
Generates an unmodifiable attribute with the values for the provided entry.
|
void |
initializeVirtualAttributeProvider(EntityTagVirtualAttributeCfg configuration)
Initializes this virtual attribute based on the information in the provided configuration entry.
|
boolean |
isConfigurationChangeAcceptable(EntityTagVirtualAttributeCfg 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 ConfigChangeResult applyConfigurationChange(EntityTagVirtualAttributeCfg configuration)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<EntityTagVirtualAttributeCfg>
configuration
- The new configuration containing the changes.public void finalizeVirtualAttributeProvider()
VirtualAttributeProvider
finalizeVirtualAttributeProvider
in class VirtualAttributeProvider<EntityTagVirtualAttributeCfg>
public Attribute getAttribute(Entry entry, AttributeDescription attributeDescription)
VirtualAttributeProvider
getAttribute
in class VirtualAttributeProvider<EntityTagVirtualAttributeCfg>
entry
- The entry for which the values are to be generated.attributeDescription
- the attribute description corresponding to this virtual attributenull
.public void initializeVirtualAttributeProvider(EntityTagVirtualAttributeCfg configuration)
VirtualAttributeProvider
initializeVirtualAttributeProvider
in class VirtualAttributeProvider<EntityTagVirtualAttributeCfg>
configuration
- The configuration to use to initialize this virtual attribute provider.public boolean isConfigurationChangeAcceptable(EntityTagVirtualAttributeCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<EntityTagVirtualAttributeCfg>
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 boolean isMultiValued()
VirtualAttributeProvider
isMultiValued
in class VirtualAttributeProvider<EntityTagVirtualAttributeCfg>
true
if this virtual attribute provider may generate multiple values, or false
if not.Copyright 2010-2018 ForgeRock AS.