Package org.forgerock.opendj.server.config.client

Interface MemberVirtualAttributeCfgClient

All Superinterfaces:

ConfigurationClient, VirtualAttributeCfgClient

public interface MemberVirtualAttributeCfgClient
extends VirtualAttributeCfgClient

A client-side interface for reading and modifying 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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends MemberVirtualAttributeCfgClient,? extends MemberVirtualAttributeCfg>	definition()	Get the configuration definition associated with this Member Virtual Attribute.
ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior>	getConflictBehavior()	Gets the "conflict-behavior" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isAllowRetrievingMembership()	Gets the "allow-retrieving-membership" property.
void	setAllowRetrievingMembership(ValueOrExpression<Boolean> value)	Sets the "allow-retrieving-membership" property.
void	setConflictBehavior(ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior> value)	Sets the "conflict-behavior" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.VirtualAttributeCfgClient

getAttributeType, getBaseDn, getFilter, getGroupDn, getScope, isEnabled, setAttributeType, setBaseDn, setEnabled, setFilter, setGroupDn, setScope

Method Detail

definition

ManagedObjectDefinition<? extends MemberVirtualAttributeCfgClient,? extends MemberVirtualAttributeCfg> definition()

Get the configuration definition associated with this Member Virtual Attribute.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface VirtualAttributeCfgClient

Returns:

Returns the configuration definition associated with this Member Virtual Attribute.

isAllowRetrievingMembership

@MandatoryProperty
ValueOrExpression<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.

Default value: false

Returns:

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

setAllowRetrievingMembership

@MandatoryProperty
void setAllowRetrievingMembership(ValueOrExpression<Boolean> value)
                           throws PropertyException

Sets 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.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getConflictBehavior

ValueOrExpression<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.

Default value: virtual-overrides-real

Specified by:

getConflictBehavior in interface VirtualAttributeCfgClient

Returns:

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

setConflictBehavior

void setConflictBehavior(ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior> value)
                  throws PropertyException

Sets 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:

setConflictBehavior in interface VirtualAttributeCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.extensions.MemberVirtualAttributeProvider

Specified by:

getJavaClass in interface VirtualAttributeCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface VirtualAttributeCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.