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

Interface UserTemplateVirtualAttributeCfg

  • All Superinterfaces:
    Configuration, VirtualAttributeCfg
    public interface UserTemplateVirtualAttributeCfg
extends VirtualAttributeCfg
    A server-side interface for querying 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 Detail

      • addUserTemplateChangeListener

        void addUserTemplateChangeListener​(ConfigurationChangeListener<UserTemplateVirtualAttributeCfg> listener)
        Register to be notified when this User Template Virtual Attribute is changed.
        Parameters:
        listener - The User Template Virtual Attribute configuration change listener.

      • removeUserTemplateChangeListener

        void removeUserTemplateChangeListener​(ConfigurationChangeListener<UserTemplateVirtualAttributeCfg> listener)
        Deregister an existing User Template Virtual Attribute configuration change listener.
        Parameters:
        listener - The User Template 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.

        Default value: org.opends.server.extensions.UserTemplateVirtualAttributeProvider

        Specified by:
        getJavaClass in interface VirtualAttributeCfg
        Returns:
        Returns the value of the "java-class" property.

      • getTemplate

        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.