org.opends.server.admin.std.server
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 Summary
 void addLDAPAttributeDescriptionListChangeListener(ConfigurationChangeListener<LDAPAttributeDescriptionListPluginCfg> listener)
          Register to be notified when this LDAP Attribute Description List Plugin is changed.
 java.lang.Class<? extends LDAPAttributeDescriptionListPluginCfg> configurationClass()
          Gets the configuration class associated with this LDAP Attribute Description List Plugin.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
          Gets the "plugin-type" property.
 void removeLDAPAttributeDescriptionListChangeListener(ConfigurationChangeListener<LDAPAttributeDescriptionListPluginCfg> listener)
          Deregister an existing LDAP Attribute Description List Plugin configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.PluginCfg
addChangeListener, isEnabled, isInvokeForInternalOperations, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends LDAPAttributeDescriptionListPluginCfg> configurationClass()
Gets the configuration class associated with this LDAP Attribute Description List Plugin.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface PluginCfg
Returns:
Returns the configuration class associated with this LDAP Attribute Description List Plugin.

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

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

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

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

getPluginType

java.util.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.

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