Package org.forgerock.opendj.server.config.client

Interface SubjectDNToUserAttributeCertificateMapperCfgClient

  • All Superinterfaces:
    CertificateMapperCfgClient, ConfigurationClient
    public interface SubjectDNToUserAttributeCertificateMapperCfgClient
extends CertificateMapperCfgClient
    A client-side interface for reading and modifying Subject DN To User Attribute Certificate Mapper settings.

    The Subject DN To User Attribute Certificate Mapper maps client certificates to user entries by looking for the certificate subject DN in a specified attribute of user entries.

    • Method Detail

      • getJavaClass

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

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

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

      • setJavaClass

        void setJavaClass​(String value)
           throws PropertyException
        Sets the "java-class" property.

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

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

      • getSubjectAttribute

        org.forgerock.opendj.ldap.schema.AttributeType getSubjectAttribute()
        Gets the "subject-attribute" property.

        Specifies the name or OID of the attribute whose value should exactly match the certificate subject DN.

        Returns:
        Returns the value of the "subject-attribute" property.

      • setSubjectAttribute

        void setSubjectAttribute​(org.forgerock.opendj.ldap.schema.AttributeType value)
                  throws PropertyException
        Sets the "subject-attribute" property.

        Specifies the name or OID of the attribute whose value should exactly match the certificate subject DN.

        Parameters:
        value - The value of the "subject-attribute" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getUserBaseDN

        SortedSet<org.forgerock.opendj.ldap.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​(Collection<org.forgerock.opendj.ldap.DN> values)
            throws PropertyException
        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:
        PropertyException - If one or more of the new values are invalid.