org.opends.server.extensions

Class MemberVirtualAttributeProvider

java.lang.Object

org.opends.server.api.VirtualAttributeProvider<MemberVirtualAttributeCfg>

org.opends.server.extensions.MemberVirtualAttributeProvider

All Implemented Interfaces:

ConfigurationChangeListener<MemberVirtualAttributeCfg>

public class MemberVirtualAttributeProvider
extends VirtualAttributeProvider<MemberVirtualAttributeCfg>
implements ConfigurationChangeListener<MemberVirtualAttributeCfg>

This class implements a virtual attribute provider that works in conjunction with virtual static groups to generate the values for the member or uniqueMember attribute.

Constructor Summary

Constructors

Constructor and Description
MemberVirtualAttributeProvider()

Method Summary

Modifier and Type	Method and Description
ConfigChangeResult	applyConfigurationChange(MemberVirtualAttributeCfg configuration) Applies the configuration changes to this change listener.
Attribute	getAttribute(Entry entry, AttributeDescription attributeDescription) Generates an unmodifiable attribute with the values for the provided entry.
void	initializeVirtualAttributeProvider(MemberVirtualAttributeCfg configuration) Initializes this virtual attribute based on the information in the provided configuration entry.
boolean	isConfigurationChangeAcceptable(MemberVirtualAttributeCfg 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.

Methods inherited from class org.opends.server.api.VirtualAttributeProvider

finalizeVirtualAttributeProvider, isConfigurationAcceptable, isSearchable, processSearch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MemberVirtualAttributeProvider

public MemberVirtualAttributeProvider()

Method Detail

initializeVirtualAttributeProvider

public void initializeVirtualAttributeProvider(MemberVirtualAttributeCfg configuration)

Description copied from class: VirtualAttributeProvider

Initializes this virtual attribute based on the information in the provided configuration entry.

Overrides:

initializeVirtualAttributeProvider in class VirtualAttributeProvider<MemberVirtualAttributeCfg>

Parameters:

configuration - The configuration to use to initialize this virtual attribute provider.

isMultiValued

public boolean isMultiValued()

Description copied from class: VirtualAttributeProvider

Indicates whether this virtual attribute provider may generate multiple values.

Specified by:

isMultiValued in class VirtualAttributeProvider<MemberVirtualAttributeCfg>

Returns:

true if this virtual attribute provider may generate multiple values, or false if not.

getAttribute

public Attribute getAttribute(Entry entry,
                              AttributeDescription attributeDescription)

Description copied from class: VirtualAttributeProvider

Generates an unmodifiable attribute with the values for the provided entry.

Specified by:

getAttribute in class VirtualAttributeProvider<MemberVirtualAttributeCfg>

Parameters:

entry - The entry for which the values are to be generated.

attributeDescription - the attribute description corresponding to this virtual attribute

Returns:

The unmodifiable attribute with the values generated for the provided entry. It may be empty, but it must not be null.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(MemberVirtualAttributeCfg configuration,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<MemberVirtualAttributeCfg>

Parameters:

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.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(MemberVirtualAttributeCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<MemberVirtualAttributeCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.