Interface SubjectAttributeToUserAttributeCertificateMapperCfg

  • All Superinterfaces:
    CertificateMapperCfg, Configuration

    public interface SubjectAttributeToUserAttributeCertificateMapperCfg
    extends CertificateMapperCfg
    A server-side interface for querying 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 Detail

      • addSubjectAttributeToUserAttributeChangeListener

        void addSubjectAttributeToUserAttributeChangeListener​(ConfigurationChangeListener<SubjectAttributeToUserAttributeCertificateMapperCfg> listener)
        Register to be notified when this Subject Attribute To User Attribute Certificate Mapper is changed.
        Parameters:
        listener - The Subject Attribute To User Attribute Certificate Mapper configuration change listener.
      • removeSubjectAttributeToUserAttributeChangeListener

        void removeSubjectAttributeToUserAttributeChangeListener​(ConfigurationChangeListener<SubjectAttributeToUserAttributeCertificateMapperCfg> listener)
        Deregister an existing Subject Attribute To User Attribute Certificate Mapper configuration change listener.
        Parameters:
        listener - The Subject Attribute To User Attribute Certificate Mapper configuration change listener.
      • getJavaClass

        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.

        Default value: org.opends.server.extensions.SubjectAttributeToUserAttributeCertificateMapper

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

        SortedSet<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 an unmodifiable set containing the values of the "subject-attribute-mapping" property.
      • getUserBaseDn

        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 an unmodifiable set containing the values of the "user-base-dn" property.