Package com.netscape.cmscore.cert
Class X500NameSubsystem
- java.lang.Object
-
- com.netscape.cmscore.cert.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
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IConfigStoregetConfigStore()Returns the root configuration storage of this system.java.lang.StringgetId()Retrieves subsystem identifier.static X500NameSubsystemgetInstance()voidinit(IConfigStore config)Initializes this subsystem with the given configuration store.voidsetId(java.lang.String id)Sets specific to this subsystem.voidshutdown()Stops this system.voidstartup()Notifies this subsystem if owner is in running mode.
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
ID
public static final java.lang.String ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
getId
public java.lang.String getId()
Retrieves subsystem identifier.- Specified by:
getIdin interfaceISubsystem- Returns:
- subsystem identifier
-
setId
public void setId(java.lang.String id) throws EBaseExceptionDescription copied from interface:ISubsystemSets specific to this subsystem.- Specified by:
setIdin interfaceISubsystem- Parameters:
id- subsystem identifier- Throws:
EBaseException- failed to set id
-
getInstance
public static X500NameSubsystem getInstance()
-
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:
initin interfaceISubsystem- Parameters:
config- configuration store- Throws:
EBaseException- failed to initialize
- Change encoding order of Directory Strings:
-
startup
public void startup() throws EBaseExceptionDescription copied from interface:ISubsystemNotifies this subsystem if owner is in running mode.- Specified by:
startupin interfaceISubsystem- Throws:
EBaseException- failed to start up
-
shutdown
public void shutdown()
Stops this system.- Specified by:
shutdownin interfaceISubsystem
-
getConfigStore
public IConfigStore getConfigStore()
Description copied from interface:ISubsystemReturns the root configuration storage of this system.- Specified by:
getConfigStorein interfaceISubsystem- Returns:
- configuration store of this subsystem
-
-