public class UserDefinedVirtualAttributeProvider extends VirtualAttributeProvider<org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg> implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg>
Constructor and Description |
---|
UserDefinedVirtualAttributeProvider()
Creates a new instance of this member virtual attribute provider.
|
Modifier and Type | Method and Description |
---|---|
org.forgerock.opendj.config.server.ConfigChangeResult |
applyConfigurationChange(org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg configuration) |
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(org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg configuration)
Initializes this virtual attribute based on the information in
the provided configuration entry.
|
boolean |
isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg configuration,
List<LocalizableMessage> unacceptableReasons) |
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, matchesSubstring
public UserDefinedVirtualAttributeProvider()
public void initializeVirtualAttributeProvider(org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg configuration) throws org.forgerock.opendj.config.server.ConfigException, InitializationException
VirtualAttributeProvider
initializeVirtualAttributeProvider
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg>
configuration
- The configuration to use to initialize
this virtual attribute provider.org.forgerock.opendj.config.server.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<org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg>
public boolean isMultiValued()
VirtualAttributeProvider
isMultiValued
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg>
true
if this virtual attribute provider may
generate multiple values, or false
if not.public Attribute getValues(Entry entry, VirtualAttributeRule rule)
VirtualAttributeProvider
getValues
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.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)
VirtualAttributeProvider
isSearchable
in class VirtualAttributeProvider<org.forgerock.opendj.server.config.server.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)
VirtualAttributeProvider
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<org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg>
rule
- The virtual attribute rule which defines
the constraints for the virtual
attribute.searchOperation
- The search operation to be processed.public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg>
public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg configuration)
applyConfigurationChange
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.UserDefinedVirtualAttributeCfg>
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.