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

Interface UserTemplateVirtualAttributeCfgClient

All Superinterfaces:

ConfigurationClient, VirtualAttributeCfgClient

public interface UserTemplateVirtualAttributeCfgClient
extends VirtualAttributeCfgClient

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

The User Template Virtual Attribute generates attribute values using a customizable template whose expressions are replaced by values from referenced attributes in the target entry.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends UserTemplateVirtualAttributeCfgClient,? extends UserTemplateVirtualAttributeCfg>	definition()	Get the configuration definition associated with this User Template Virtual Attribute.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<String>	getTemplate()	Gets the "template" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setTemplate(ValueOrExpression<String> value)	Sets the "template" 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 Detail

definition

ManagedObjectDefinition<? extends UserTemplateVirtualAttributeCfgClient,? extends UserTemplateVirtualAttributeCfg> definition()

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

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface VirtualAttributeCfgClient

Returns:

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

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.

getTemplate

@MandatoryProperty
ValueOrExpression<String> getTemplate()

Gets the "template" property.

Specifies the template that is used to generate a value(s) to be included in the virtual attribute. A string possibly containing reference attribute names surrounded by `{` and `}` whose values are to be used for building the virtual attribute. Ex: '{uid}' Default values for missing references can be specified by separating with '|' the reference attribute name and the default value. Ex: '{domain|example.com}' When '{' have to appear in the final value, they can be escaped with '\\'.

Returns:

Returns the value of the "template" property.

setTemplate

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

Sets the "template" property.

Specifies the template that is used to generate a value(s) to be included in the virtual attribute. A string possibly containing reference attribute names surrounded by `{` and `}` whose values are to be used for building the virtual attribute. Ex: '{uid}' Default values for missing references can be specified by separating with '|' the reference attribute name and the default value. Ex: '{domain|example.com}' When '{' have to appear in the final value, they can be escaped with '\\'.

Parameters:

value - The value of the "template" property.

Throws:

PropertyException - If the new value is invalid.