org.opends.server.admin.std.client
Interface LDAPAttributeDescriptionListPluginCfgClient

All Superinterfaces:
ConfigurationClient, PluginCfgClient

public interface LDAPAttributeDescriptionListPluginCfgClient
extends PluginCfgClient

A client-side interface for reading and modifying 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
 ManagedObjectDefinition<? extends LDAPAttributeDescriptionListPluginCfgClient,? extends LDAPAttributeDescriptionListPluginCfg> definition()
          Get the configuration definition 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 setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
          Sets the "plugin-type" property.
 
Methods inherited from interface org.opends.server.admin.std.client.PluginCfgClient
isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends LDAPAttributeDescriptionListPluginCfgClient,? extends LDAPAttributeDescriptionListPluginCfg> definition()
Get the configuration definition associated with this LDAP Attribute Description List Plugin.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface PluginCfgClient
Returns:
Returns the configuration definition associated with this LDAP Attribute Description List Plugin.

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 PluginCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Specified by:
setJavaClass in interface PluginCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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 PluginCfgClient
Returns:
Returns the values of the "plugin-type" property.

setPluginType

void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
                   throws IllegalPropertyValueException
Sets 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:
setPluginType in interface PluginCfgClient
Parameters:
values - The values of the "plugin-type" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.