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

Interface UserDefinedVirtualAttributeCfgClient

All Superinterfaces:

ConfigurationClient, VirtualAttributeCfgClient

public interface UserDefinedVirtualAttributeCfgClient
extends VirtualAttributeCfgClient

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

The User Defined Virtual Attribute creates virtual attributes with user-defined values in entries that match the criteria defined in the plug-in's configuration.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends UserDefinedVirtualAttributeCfgClient,? extends UserDefinedVirtualAttributeCfg>	definition()	Get the configuration definition associated with this User Defined Virtual Attribute.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
SortedSet<ValueOrExpression<String>>	getValue()	Gets the "value" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setValue(Collection<ValueOrExpression<String>> values)	Sets the "value" 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, getConflictBehavior, getFilter, getGroupDn, getScope, isEnabled, setAttributeType, setBaseDn, setConflictBehavior, setEnabled, setFilter, setGroupDn, setScope

Method Details

definition

ManagedObjectDefinition<? extends UserDefinedVirtualAttributeCfgClient,? extends UserDefinedVirtualAttributeCfg> definition()

Get the configuration definition associated with this User Defined Virtual Attribute.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface VirtualAttributeCfgClient

Returns:

Returns the configuration definition associated with this User Defined Virtual Attribute.

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

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.

getValue

@MandatoryProperty
SortedSet<ValueOrExpression<String>> getValue()

Gets the "value" property.

Specifies the values to be included in the virtual attribute.

Returns:

Returns the values of the "value" property.

setValue

@MandatoryProperty
void setValue(Collection<ValueOrExpression<String>> values)
       throws PropertyException

Sets the "value" property.

Specifies the values to be included in the virtual attribute.

Parameters:

values - The values of the "value" property.

Throws:

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