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

Interface UserDefinedVirtualAttributeCfg

All Superinterfaces:

Configuration, VirtualAttributeCfg

public interface UserDefinedVirtualAttributeCfg
extends VirtualAttributeCfg

A server-side interface for querying 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
void	addUserDefinedChangeListener(ConfigurationChangeListener<UserDefinedVirtualAttributeCfg> listener)	Register to be notified when this User Defined Virtual Attribute is changed.
Class<? extends UserDefinedVirtualAttributeCfg>	configurationClass()	Gets the configuration class associated with this User Defined Virtual Attribute.
String	getJavaClass()	Gets the "java-class" property.
SortedSet<String>	getValue()	Gets the "value" property.
void	removeUserDefinedChangeListener(ConfigurationChangeListener<UserDefinedVirtualAttributeCfg> listener)	Deregister an existing User Defined Virtual Attribute configuration change listener.

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

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.VirtualAttributeCfg

addChangeListener, getAttributeType, getBaseDN, getConflictBehavior, getFilter, getGroupDN, getScope, isEnabled, removeChangeListener

Method Detail

configurationClass

Class<? extends UserDefinedVirtualAttributeCfg> configurationClass()

Gets the configuration class associated with this User Defined Virtual Attribute.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface VirtualAttributeCfg

Returns:

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

addUserDefinedChangeListener

void addUserDefinedChangeListener(ConfigurationChangeListener<UserDefinedVirtualAttributeCfg> listener)

Register to be notified when this User Defined Virtual Attribute is changed.

Parameters:

listener - The User Defined Virtual Attribute configuration change listener.

removeUserDefinedChangeListener

void removeUserDefinedChangeListener(ConfigurationChangeListener<UserDefinedVirtualAttributeCfg> listener)

Deregister an existing User Defined Virtual Attribute configuration change listener.

Parameters:

listener - The User Defined Virtual Attribute configuration change listener.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface VirtualAttributeCfg

Returns:

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

getValue

SortedSet<String> getValue()

Gets the "value" property.

Specifies the values to be included in the virtual attribute.

Returns:

Returns an unmodifiable set containing the values of the "value" property.