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

Interface EntryDnVirtualAttributeCfgClient

All Superinterfaces:

ConfigurationClient, VirtualAttributeCfgClient

public interface EntryDnVirtualAttributeCfgClient
extends VirtualAttributeCfgClient

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

The entryDN Virtual Attribute generates the entryDN operational attribute in directory entries, which contains a normalized form of the entry's DN.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends EntryDnVirtualAttributeCfgClient,? extends EntryDnVirtualAttributeCfg>	definition()	Get the configuration definition associated with this entryDN Virtual Attribute.
ValueOrExpression<AttributeType>	getAttributeType()	Gets the "attribute-type" property.
ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior>	getConflictBehavior()	Gets the "conflict-behavior" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setAttributeType(ValueOrExpression<AttributeType> value)	Sets the "attribute-type" 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

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

Method Details

definition

ManagedObjectDefinition<? extends EntryDnVirtualAttributeCfgClient,? extends EntryDnVirtualAttributeCfg> definition()

Get the configuration definition associated with this entryDN Virtual Attribute.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface VirtualAttributeCfgClient

Returns:

Returns the configuration definition associated with this entryDN 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.

Default value: entryDN

Specified by:

getAttributeType in interface VirtualAttributeCfgClient

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.

Specified by:

setAttributeType in interface VirtualAttributeCfgClient

Parameters:

value - The value of the "attribute-type" 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.EntryDNVirtualAttributeProvider

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.