org.opends.server.admin.std.meta
Class CertificateMapperCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<CertificateMapperCfgClient,CertificateMapperCfg>
          extended by org.opends.server.admin.std.meta.CertificateMapperCfgDefn

public final class CertificateMapperCfgDefn
extends ManagedObjectDefinition<CertificateMapperCfgClient,CertificateMapperCfg>

An interface for querying the Certificate Mapper managed object definition meta information.

Certificate Mappers are responsible for establishing a mapping between a client certificate and the entry for the user that corresponds to that certificate.


Method Summary
 CertificateMapperCfgClient createClientConfiguration(ManagedObject<? extends CertificateMapperCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 CertificateMapperCfg createServerConfiguration(ServerManagedObject<? extends CertificateMapperCfg> impl)
          Creates a server configuration view of the provided server managed object.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static CertificateMapperCfgDefn getInstance()
          Get the Certificate Mapper configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 java.lang.Class<CertificateMapperCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 
Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getInstance

public static CertificateMapperCfgDefn getInstance()
Get the Certificate Mapper configuration definition singleton.

Returns:
Returns the Certificate Mapper configuration definition singleton.

createClientConfiguration

public CertificateMapperCfgClient createClientConfiguration(ManagedObject<? extends CertificateMapperCfgClient> impl)
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:
createClientConfiguration in class ManagedObjectDefinition<CertificateMapperCfgClient,CertificateMapperCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public CertificateMapperCfg createServerConfiguration(ServerManagedObject<? extends CertificateMapperCfg> impl)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<CertificateMapperCfgClient,CertificateMapperCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<CertificateMapperCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<CertificateMapperCfgClient,CertificateMapperCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.

Indicates whether the Certificate Mapper is enabled.

Returns:
Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.

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

Returns:
Returns the "java-class" property definition.