org.opends.server.admin.std.server

Interface MemberVirtualAttributeCfg

All Superinterfaces:

Configuration, VirtualAttributeCfg

public interface MemberVirtualAttributeCfg
extends VirtualAttributeCfg

A server-side interface for querying Member Virtual Attribute settings.

The Member Virtual Attribute generates a member or uniqueMember attribute whose values are the DNs of the members of a specified virtual static group.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMemberChangeListener(ConfigurationChangeListener<MemberVirtualAttributeCfg> listener) Register to be notified when this Member Virtual Attribute is changed.
Class<? extends MemberVirtualAttributeCfg>	configurationClass() Gets the configuration class associated with this Member Virtual Attribute.
VirtualAttributeCfgDefn.ConflictBehavior	getConflictBehavior() Gets the "conflict-behavior" property.
String	getJavaClass() Gets the "java-class" property.
boolean	isAllowRetrievingMembership() Gets the "allow-retrieving-membership" property.
void	removeMemberChangeListener(ConfigurationChangeListener<MemberVirtualAttributeCfg> listener) Deregister an existing Member Virtual Attribute configuration change listener.

Methods inherited from interface org.opends.server.admin.std.server.VirtualAttributeCfg

addChangeListener, getAttributeType, getBaseDN, getFilter, getGroupDN, getScope, isEnabled, removeChangeListener

Methods inherited from interface org.opends.server.admin.Configuration

dn

Method Detail

configurationClass

Class<? extends MemberVirtualAttributeCfg> configurationClass()

Gets the configuration class associated with this Member Virtual Attribute.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface VirtualAttributeCfg

Returns:

Returns the configuration class associated with this Member Virtual Attribute.

addMemberChangeListener

void addMemberChangeListener(ConfigurationChangeListener<MemberVirtualAttributeCfg> listener)

Register to be notified when this Member Virtual Attribute is changed.

Parameters:

listener - The Member Virtual Attribute configuration change listener.

removeMemberChangeListener

void removeMemberChangeListener(ConfigurationChangeListener<MemberVirtualAttributeCfg> listener)

Deregister an existing Member Virtual Attribute configuration change listener.

Parameters:

listener - The Member Virtual Attribute configuration change listener.

isAllowRetrievingMembership

boolean isAllowRetrievingMembership()

Gets the "allow-retrieving-membership" property.

Indicates whether to handle requests that request all values for the virtual attribute.

This operation can be very expensive in some cases and is not consistent with the primary function of virtual static groups, which is to make it possible to use static group idioms to determine whether a given user is a member. If this attribute is set to false, attempts to retrieve the entire set of values receive an empty set, and only attempts to determine whether the attribute has a specific value or set of values (which is the primary anticipated use for virtual static groups) are handled properly.

Returns:

Returns the value of the "allow-retrieving-membership" property.

getConflictBehavior

VirtualAttributeCfgDefn.ConflictBehavior getConflictBehavior()

Gets the "conflict-behavior" property.

Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.

Specified by:

getConflictBehavior in interface VirtualAttributeCfg

Returns:

Returns the value of the "conflict-behavior" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.

Specified by:

getJavaClass in interface VirtualAttributeCfg

Returns:

Returns the value of the "java-class" property.