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

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
ExactMatchIdentityMapperCfgClient, RegularExpressionIdentityMapperCfgClient

public interface IdentityMapperCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Identity Mapper settings.

Identity Mappers are responsible for establishing a mapping between an identifier string provided by a client, and the entry for the user that corresponds to that identifier. Identity Mappers are used to process several SASL mechanisms to map an authorization ID (e.g., a Kerberos principal when using GSSAPI) to a directory user. They are also used when processing requests with the proxied authorization control.


Method Summary
 ManagedObjectDefinition<? extends IdentityMapperCfgClient,? extends IdentityMapperCfg> definition()
          Get the configuration definition associated with this Identity Mapper.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends IdentityMapperCfgClient,? extends IdentityMapperCfg> definition()
Get the configuration definition associated with this Identity Mapper.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Identity Mapper.

isEnabled

java.lang.Boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Identity Mapper is enabled for use.

Returns:
Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets the "enabled" property.

Indicates whether the Identity Mapper is enabled for use.

Parameters:
value - The value of the "enabled" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

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

Specifies the fully-qualified name of the Java class that provides the Identity Mapper implementation.

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 Identity Mapper implementation.

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.