Interface LdapAttributeDescriptionListPluginCfg

  • All Superinterfaces:
    Configuration, PluginCfg

    public interface LdapAttributeDescriptionListPluginCfg
    extends PluginCfg
    A server-side interface for querying LDAP Attribute Description List Plugin settings.

    The LDAP Attribute Description List Plugin provides the ability for clients to include an attribute list in a search request that names object classes instead of (or in addition to) attributes.

    • Method Detail

      • addLdapAttributeDescriptionListChangeListener

        void addLdapAttributeDescriptionListChangeListener​(ConfigurationChangeListener<LdapAttributeDescriptionListPluginCfg> listener)
        Register to be notified when this LDAP Attribute Description List Plugin is changed.
        Parameters:
        listener - The LDAP Attribute Description List Plugin configuration change listener.
      • removeLdapAttributeDescriptionListChangeListener

        void removeLdapAttributeDescriptionListChangeListener​(ConfigurationChangeListener<LdapAttributeDescriptionListPluginCfg> listener)
        Deregister an existing LDAP Attribute Description List Plugin configuration change listener.
        Parameters:
        listener - The LDAP Attribute Description List Plugin configuration change listener.
      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

        Default value: org.opends.server.plugins.LDAPADListPlugin

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

        SortedSet<PluginCfgDefn.PluginType> getPluginType()
        Gets the "plugin-type" property.

        Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

        Default value: preparsesearch

        Specified by:
        getPluginType in interface PluginCfg
        Returns:
        Returns an unmodifiable set containing the values of the "plugin-type" property.