|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.VirtualAttributeProvider<UserDefinedVirtualAttributeCfg>
org.opends.server.extensions.UserDefinedVirtualAttributeProvider
public class UserDefinedVirtualAttributeProvider
This class implements a virtual attribute provider that allows administrators to define their own values that will be inserted into any entry that matches the criteria defined in the virtual attribute rule. This can be used to provide functionality like Class of Service (CoS) in the Sun Java System Directory Server.
Constructor Summary | |
---|---|
UserDefinedVirtualAttributeProvider()
Creates a new instance of this member virtual attribute provider. |
Method Summary | |
---|---|
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. |
java.util.LinkedHashSet<AttributeValue> |
getValues(Entry entry,
VirtualAttributeRule rule)
Generates a set of 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,
java.util.List<Message> 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)
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. |
Methods inherited from class org.opends.server.api.VirtualAttributeProvider |
---|
approximatelyEqualTo, greaterThanOrEqualTo, hasAllValues, hasAnyValue, hasValue, hasValue, isConfigurationAcceptable, lessThanOrEqualTo, matchesSubstring |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserDefinedVirtualAttributeProvider()
Method Detail |
---|
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 java.util.LinkedHashSet<AttributeValue> 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)
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.
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, java.util.List<Message> 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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |