Class LdapDNStrConverter

  • Direct Known Subclasses:
    LdapV3DNStrConverter

    public abstract class LdapDNStrConverter
    extends java.lang.Object
    Abstract class that converts a Ldap DN String to an X500Name, RDN or AVA and vice versa, except the string is a java string in unicode.
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract java.lang.String encodeAVA​(AVA ava)
      Converts an AVA object to a Ldap dn string.
      abstract java.lang.String encodeDN​(X500Name dn)
      Converts a X500Name object to a Ldap dn string.
      abstract java.lang.String encodeRDN​(RDN rdn)
      Converts an RDN object to a Ldap dn string.
      static LdapDNStrConverter getDefault()
      Gets a global default Ldap DN String converter.
      abstract AVA parseAVA​(java.lang.String ava)
      Converts a Ldap DN string to a AVA object.
      abstract AVA parseAVA​(java.lang.String rdn, byte[] tags)
      Like parseAVA with a specified DER encoding order for Directory Strings.
      abstract X500Name parseDN​(java.lang.String dn)
      Converts a Ldap DN string to a X500Name object.
      abstract X500Name parseDN​(java.lang.String dn, byte[] tags)
      Like parseDN with a specified DER encoding order for Directory Strings.
      abstract RDN parseRDN​(java.lang.String rdn)
      Converts a Ldap DN string to a RDN object.
      abstract RDN parseRDN​(java.lang.String rdn, byte[] tags)
      Like parseRDN with a specified DER encoding order for Directory Strings.
      static void setDefault​(LdapDNStrConverter defConverter)
      Set the global default LdapDNStrConverter object.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • LdapDNStrConverter

        public LdapDNStrConverter()
    • Method Detail

      • parseDN

        public abstract X500Name parseDN​(java.lang.String dn)
                                  throws java.io.IOException
        Converts a Ldap DN string to a X500Name object.
        Parameters:
        dn - a Ldap DN String.
        Returns:
        an X500Name object for the Ldap DN String.
        Throws:
        java.io.IOException
      • parseDN

        public abstract X500Name parseDN​(java.lang.String dn,
                                         byte[] tags)
                                  throws java.io.IOException
        Like parseDN with a specified DER encoding order for Directory Strings.
        Throws:
        java.io.IOException
      • parseRDN

        public abstract RDN parseRDN​(java.lang.String rdn)
                              throws java.io.IOException
        Converts a Ldap DN string to a RDN object.
        Parameters:
        rdn - a Ldap DN String
        Returns:
        an RDN object.
        Throws:
        java.io.IOException
      • parseRDN

        public abstract RDN parseRDN​(java.lang.String rdn,
                                     byte[] tags)
                              throws java.io.IOException
        Like parseRDN with a specified DER encoding order for Directory Strings.
        Throws:
        java.io.IOException
      • parseAVA

        public abstract AVA parseAVA​(java.lang.String ava)
                              throws java.io.IOException
        Converts a Ldap DN string to a AVA object.
        Parameters:
        ava - a Ldap DN string.
        Returns:
        an AVA object.
        Throws:
        java.io.IOException
      • parseAVA

        public abstract AVA parseAVA​(java.lang.String rdn,
                                     byte[] tags)
                              throws java.io.IOException
        Like parseAVA with a specified DER encoding order for Directory Strings.
        Throws:
        java.io.IOException
      • encodeDN

        public abstract java.lang.String encodeDN​(X500Name dn)
                                           throws java.io.IOException
        Converts a X500Name object to a Ldap dn string.
        Parameters:
        dn - an X500Name object.
        Returns:
        a Ldap DN String.
        Throws:
        java.io.IOException
      • encodeRDN

        public abstract java.lang.String encodeRDN​(RDN rdn)
                                            throws java.io.IOException
        Converts an RDN object to a Ldap dn string.
        Parameters:
        rdn - an RDN object.
        Returns:
        a Ldap dn string.
        Throws:
        java.io.IOException
      • encodeAVA

        public abstract java.lang.String encodeAVA​(AVA ava)
                                            throws java.io.IOException
        Converts an AVA object to a Ldap dn string.
        Parameters:
        ava - An AVA object.
        Returns:
        A Ldap dn string.
        Throws:
        java.io.IOException
      • getDefault

        public static LdapDNStrConverter getDefault()
        Gets a global default Ldap DN String converter. Currently it is LdapV3DNStrConverter object using the default X500NameAttrMap and accepts unknown OIDs.
        Returns:
        The global default LdapDNStrConverter instance.
        See Also:
        LdapV3DNStrConverter
      • setDefault

        public static void setDefault​(LdapDNStrConverter defConverter)
        Set the global default LdapDNStrConverter object.
        Parameters:
        defConverter - A LdapDNStrConverter object to become the global default.