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

All Superinterfaces:
CertificateMapperCfgClient, ConfigurationClient

public interface SubjectAttributeToUserAttributeCertificateMapperCfgClient
extends CertificateMapperCfgClient

A client-side interface for reading and modifying Subject Attribute To User Attribute Certificate Mapper settings.

The Subject Attribute To User Attribute Certificate Mapper maps client certificates to user entries by mapping the values of attributes contained in the certificate subject to attributes contained in user entries.


Method Summary
 ManagedObjectDefinition<? extends SubjectAttributeToUserAttributeCertificateMapperCfgClient,? extends SubjectAttributeToUserAttributeCertificateMapperCfg> definition()
          Get the configuration definition associated with this Subject Attribute To User Attribute Certificate Mapper.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<java.lang.String> getSubjectAttributeMapping()
          Gets the "subject-attribute-mapping" property.
 java.util.SortedSet<DN> getUserBaseDN()
          Gets the "user-base-dn" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setSubjectAttributeMapping(java.util.Collection<java.lang.String> values)
          Sets the "subject-attribute-mapping" property.
 void setUserBaseDN(java.util.Collection<DN> values)
          Sets the "user-base-dn" property.
 
Methods inherited from interface org.opends.server.admin.std.client.CertificateMapperCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends SubjectAttributeToUserAttributeCertificateMapperCfgClient,? extends SubjectAttributeToUserAttributeCertificateMapperCfg> definition()
Get the configuration definition associated with this Subject Attribute To User Attribute Certificate Mapper.

Specified by:
definition in interface CertificateMapperCfgClient
Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Subject Attribute To User Attribute Certificate Mapper.

getJavaClass

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

Specifies the fully-qualified name of the Java class that provides the Subject Attribute To User Attribute Certificate Mapper implementation.

Specified by:
getJavaClass in interface CertificateMapperCfgClient
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 Subject Attribute To User Attribute Certificate Mapper implementation.

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

getSubjectAttributeMapping

java.util.SortedSet<java.lang.String> getSubjectAttributeMapping()
Gets the "subject-attribute-mapping" property.

Specifies a mapping between certificate attributes and user attributes.

Each value should be in the form "certattr:userattr" where certattr is the name of the attribute in the certificate subject and userattr is the name of the corresponding attribute in user entries. There may be multiple mappings defined, and when performing the mapping values for all attributes present in the certificate subject that have mappings defined must be present in the corresponding user entries.

Returns:
Returns the values of the "subject-attribute-mapping" property.

setSubjectAttributeMapping

void setSubjectAttributeMapping(java.util.Collection<java.lang.String> values)
                                throws IllegalPropertyValueException
Sets the "subject-attribute-mapping" property.

Specifies a mapping between certificate attributes and user attributes.

Each value should be in the form "certattr:userattr" where certattr is the name of the attribute in the certificate subject and userattr is the name of the corresponding attribute in user entries. There may be multiple mappings defined, and when performing the mapping values for all attributes present in the certificate subject that have mappings defined must be present in the corresponding user entries.

Parameters:
values - The values of the "subject-attribute-mapping" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

getUserBaseDN

java.util.SortedSet<DN> getUserBaseDN()
Gets the "user-base-dn" property.

Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry.

Returns:
Returns the values of the "user-base-dn" property.

setUserBaseDN

void setUserBaseDN(java.util.Collection<DN> values)
                   throws IllegalPropertyValueException
Sets the "user-base-dn" property.

Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry.

Parameters:
values - The values of the "user-base-dn" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.