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

Interface VirtualAttributeCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

CollectiveAttributeSubentriesVirtualAttributeCfgClient, EntityTagVirtualAttributeCfgClient, EntryDnVirtualAttributeCfgClient, EntryUuidVirtualAttributeCfgClient, GoverningStructureRuleVirtualAttributeCfgClient, HasSubordinatesVirtualAttributeCfgClient, IsMemberOfVirtualAttributeCfgClient, MemberVirtualAttributeCfgClient, NumSubordinatesVirtualAttributeCfgClient, PasswordExpirationTimeVirtualAttributeCfgClient, PasswordPolicySubentryVirtualAttributeCfgClient, StructuralObjectClassVirtualAttributeCfgClient, SubschemaSubentryVirtualAttributeCfgClient, UserDefinedVirtualAttributeCfgClient, UserTemplateVirtualAttributeCfgClient

public interface VirtualAttributeCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Virtual Attribute settings.

Virtual Attributes are responsible for dynamically generating attribute values that appear in entries but are not persistently stored in the backend.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends VirtualAttributeCfgClient,? extends VirtualAttributeCfg>	definition()	Get the configuration definition associated with this Virtual Attribute.
ValueOrExpression<AttributeType>	getAttributeType()	Gets the "attribute-type" property.
SortedSet<ValueOrExpression<Dn>>	getBaseDn()	Gets the "base-dn" property.
ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior>	getConflictBehavior()	Gets the "conflict-behavior" property.
SortedSet<ValueOrExpression<String>>	getFilter()	Gets the "filter" property.
SortedSet<ValueOrExpression<Dn>>	getGroupDn()	Gets the "group-dn" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<VirtualAttributeCfgDefn.Scope>	getScope()	Gets the "scope" property.
ValueOrExpression<Boolean>	isEnabled()	Gets the "enabled" property.
void	setAttributeType(ValueOrExpression<AttributeType> value)	Sets the "attribute-type" property.
void	setBaseDn(Collection<ValueOrExpression<Dn>> values)	Sets the "base-dn" property.
void	setConflictBehavior(ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior> value)	Sets the "conflict-behavior" property.
void	setEnabled(ValueOrExpression<Boolean> value)	Sets the "enabled" property.
void	setFilter(Collection<ValueOrExpression<String>> values)	Sets the "filter" property.
void	setGroupDn(Collection<ValueOrExpression<Dn>> values)	Sets the "group-dn" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setScope(ValueOrExpression<VirtualAttributeCfgDefn.Scope> value)	Sets the "scope" property.

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends VirtualAttributeCfgClient,? extends VirtualAttributeCfg> definition()

Get the configuration definition associated with this Virtual Attribute.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Virtual Attribute.

getAttributeType

@MandatoryProperty
ValueOrExpression<AttributeType> getAttributeType()

Gets the "attribute-type" property.

Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.

Returns:

Returns the value of the "attribute-type" property.

setAttributeType

@MandatoryProperty
void setAttributeType(ValueOrExpression<AttributeType> value)
               throws PropertyException

Sets the "attribute-type" property.

Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.

Parameters:

value - The value of the "attribute-type" property.

Throws:

PropertyException - If the new value is invalid.

getBaseDn

SortedSet<ValueOrExpression<Dn>> getBaseDn()

Gets the "base-dn" property.

Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute.

If no values are given, then the server generates virtual attributes anywhere in the server.

Returns:

Returns the values of the "base-dn" property.

setBaseDn

void setBaseDn(Collection<ValueOrExpression<Dn>> values)
        throws PropertyException

Sets the "base-dn" property.

Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute.

If no values are given, then the server generates virtual attributes anywhere in the server.

Parameters:

values - The values of the "base-dn" property.

Throws:

PropertyException - If one or more of the new values are 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: real-overrides-virtual

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.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

isEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isEnabled()

Gets the "enabled" property.

Indicates whether the Virtual Attribute is enabled for use.

Returns:

Returns the value of the "enabled" property.

setEnabled

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

Sets the "enabled" property.

Indicates whether the Virtual Attribute is enabled for use.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.

getFilter

SortedSet<ValueOrExpression<String>> getFilter()

Gets the "filter" property.

Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries.

If no values are given, then any entry is eligible to have the value generated. If one or more filters are specified, then only entries that match at least one of those filters are allowed to have the virtual attribute.

Default value: (objectClass=*)

Returns:

Returns the values of the "filter" property.

setFilter

void setFilter(Collection<ValueOrExpression<String>> values)
        throws PropertyException

Sets the "filter" property.

Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries.

If no values are given, then any entry is eligible to have the value generated. If one or more filters are specified, then only entries that match at least one of those filters are allowed to have the virtual attribute.

Parameters:

values - The values of the "filter" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getGroupDn

SortedSet<ValueOrExpression<Dn>> getGroupDn()

Gets the "group-dn" property.

Specifies the DNs of the groups whose members can be eligible to use this virtual attribute.

If no values are given, then group membership is not taken into account when generating the virtual attribute. If one or more group DNs are specified, then only members of those groups are allowed to have the virtual attribute.

Returns:

Returns the values of the "group-dn" property.

setGroupDn

void setGroupDn(Collection<ValueOrExpression<Dn>> values)
         throws PropertyException

Sets the "group-dn" property.

Specifies the DNs of the groups whose members can be eligible to use this virtual attribute.

If no values are given, then group membership is not taken into account when generating the virtual attribute. If one or more group DNs are specified, then only members of those groups are allowed to have the virtual attribute.

Parameters:

values - The values of the "group-dn" property.

Throws:

PropertyException - If one or more of the new values are 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.

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.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getScope

ValueOrExpression<VirtualAttributeCfgDefn.Scope> getScope()

Gets the "scope" property.

Specifies the LDAP scope associated with base DNs for entries that are eligible to use this virtual attribute.

Default value: whole-subtree

Returns:

Returns the value of the "scope" property.

setScope

void setScope(ValueOrExpression<VirtualAttributeCfgDefn.Scope> value)
       throws PropertyException

Sets the "scope" property.

Specifies the LDAP scope associated with base DNs for entries that are eligible to use this virtual attribute.

Parameters:

value - The value of the "scope" property.

Throws:

PropertyException - If the new value is invalid.