Class X500NameSubsystem

  • All Implemented Interfaces:
    ISubsystem

    public class X500NameSubsystem
    extends java.lang.Object
    implements ISubsystem
    Subsystem for configuring X500Name related things. It is used for the following.
    • Add X500Name (string to oid) maps for attributes that are not supported by default.
    • Specify an order for encoding Directory Strings other than the default.
    Version:
    $Revision$
    Author:
    lhsiao
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ID  
      static org.slf4j.Logger logger  
    • Field Detail

      • logger

        public static org.slf4j.Logger logger
    • Method Detail

      • getId

        public java.lang.String getId()
        Retrieves subsystem identifier.
        Specified by:
        getId in interface ISubsystem
        Returns:
        subsystem identifier
      • setId

        public void setId​(java.lang.String id)
                   throws EBaseException
        Description copied from interface: ISubsystem
        Sets specific to this subsystem.
        Specified by:
        setId in interface ISubsystem
        Parameters:
        id - subsystem identifier
        Throws:
        EBaseException - failed to set id
      • init

        public void init​(IConfigStore config)
                  throws EBaseException
        Initializes this subsystem with the given configuration store. All paramters are optional.
        • Change encoding order of Directory Strings:
           X500Name.directoryStringEncodingOrder=order seperated by commas
           For example: Printable,BMPString,UniversalString.
           
          Possible values are:
          • Printable
          • IA5String
          • UniversalString
          • BMPString
          • UTF8String

        • Add X500Name attributes:
           X500Name.attr.attribute-name.oid=n.n.n.n
           X500Name.attr.attribute-name.class=value converter class
           
          The value converter class converts a string to a ASN.1 value. It must implement org.mozilla.jss.netscape.security.x509.AVAValueConverter interface. Converter classes provided in CMS are:
               org.mozilla.jss.netscape.security.x509.PrintableConverter -
                          Converts to a Printable String value. String must have only
                          printable characters.
               org.mozilla.jss.netscape.security.x509.IA5StringConverter -
                          Converts to a IA5String value. String must have only IA5String
                          characters.
               org.mozilla.jss.netscape.security.x509.DirStrConverter -
                          Converts to a Directory (v3) String. String is expected to
                          be in Directory String format according to rfc2253.
               org.mozilla.jss.netscape.security.x509.GenericValueConverter -
                          Converts string character by character in the following order
                          from smaller character sets to broadest character set.
                                  Printable, IA5String, BMPString, Universal String.
           

        Specified by:
        init in interface ISubsystem
        Parameters:
        config - configuration store
        Throws:
        EBaseException - failed to initialize
      • shutdown

        public void shutdown()
        Stops this system.
        Specified by:
        shutdown in interface ISubsystem
      • getConfigStore

        public IConfigStore getConfigStore()
        Description copied from interface: ISubsystem
        Returns the root configuration storage of this system.

        Specified by:
        getConfigStore in interface ISubsystem
        Returns:
        configuration store of this subsystem