GeneralNameUtil (pki-javadoc)

java.lang.Object
- org.dogtagpki.legacy.core.policy.GeneralNameUtil

All Implemented Interfaces:

IGeneralNameUtil
```
public class GeneralNameUtil
extends java.lang.Object
implements IGeneralNameUtil
```
Class that can be used to form general names from configuration file. Used by policies and extension commands.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GeneralNameUtil.GeneralNameAsConstraintsConfig` convenience class for policies use.
`static class`	`GeneralNameUtil.GeneralNameConfig` convenience class for policies use.
`static class`	`GeneralNameUtil.GeneralNamesAsConstraintsConfig`
`static class`	`GeneralNameUtil.GeneralNamesConfig`
`static class`	`GeneralNameUtil.SubjAltNameGN`

Field Summary

Fields
Modifier and Type Field and Description

static org.slf4j.Logger logger
- Fields inherited from interface org.dogtagpki.legacy.policy.IGeneralNameUtil
  DEF_NUM_GENERALNAMES, GENNAME_CHOICE_DIRECTORYNAME, GENNAME_CHOICE_DNSNAME, GENNAME_CHOICE_EDIPARTYNAME, GENNAME_CHOICE_INFO, GENNAME_CHOICE_IPADDRESS, GENNAME_CHOICE_OTHERNAME, GENNAME_CHOICE_REGISTEREDID, GENNAME_CHOICE_RFC822NAME, GENNAME_CHOICE_URL, GENNAME_CHOICE_X400ADDRESS, GENNAME_VALUE_INFO, NUM_GENERALNAMES_INFO, PROP_GENERALNAME, PROP_GENNAME_CHOICE, PROP_GENNAME_CHOICE_INFO, PROP_GENNAME_VALUE, PROP_GENNAME_VALUE_INFO, PROP_NUM_GENERALNAMES, PROP_NUM_GENERALNAMES_INFO

Fields
Modifier and Type	Field and Description
`static org.slf4j.Logger`	`logger`

Constructor Summary

Constructors
Constructor and Description

GeneralNameUtil()

Constructors
Constructor and Description
`GeneralNameUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`check_GeneralNameChoice(java.lang.String generalNameChoice)` Checks if given string is a valid General Name choice and returns the actual string that can be passed into form_GeneralName().
`static org.mozilla.jss.netscape.security.x509.GeneralName`	`form_GeneralName(java.lang.String generalNameChoice, java.lang.String value)` Form a General Name from a General Name choice and value.
`static org.mozilla.jss.netscape.security.x509.GeneralName`	`form_GeneralNameAsConstraints(java.lang.String generalNameChoice, java.lang.String value)` GeneralName can be used in the context of Constraints.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
public static org.slf4j.Logger logger
```
- Constructor Detail
  - GeneralNameUtil
```
public GeneralNameUtil()
```
- Method Detail
  - form_GeneralNameAsConstraints
```
public static org.mozilla.jss.netscape.security.x509.GeneralName form_GeneralNameAsConstraints(java.lang.String generalNameChoice,
                                                                                               java.lang.String value)
                                                                                        throws EBaseException
```
    GeneralName can be used in the context of Constraints. Examples are NameConstraints, CertificateScopeOfUse extensions. In such cases, IPAddress may contain netmask component.
    
    Throws:
    
    EBaseException
  - form_GeneralName
```
public static org.mozilla.jss.netscape.security.x509.GeneralName form_GeneralName(java.lang.String generalNameChoice,
                                                                                  java.lang.String value)
                                                                           throws EBaseException
```
    Form a General Name from a General Name choice and value. The General Name choice must be one of the General Name Choice Strings defined in this class.
    
    Parameters:
    
    generalNameChoice - General Name choice. Must be one of the General Name choices defined in this class.
    
    value - String value of the general name to form.
    
    Throws:
    
    EBaseException
  - check_GeneralNameChoice
```
public static java.lang.String check_GeneralNameChoice(java.lang.String generalNameChoice)
                                                throws EBaseException
```
    Checks if given string is a valid General Name choice and returns the actual string that can be passed into form_GeneralName().
    
    Parameters:
    
    generalNameChoice - a General Name choice string.
    
    Returns:
    
    one of General Name choices defined in this class that can be passed into form_GeneralName().
    
    Throws:
    
    EBaseException

Class GeneralNameUtil

Nested Class Summary

Field Summary

Fields inherited from interface org.dogtagpki.legacy.policy.IGeneralNameUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

Constructor Detail

GeneralNameUtil

Method Detail

form_GeneralNameAsConstraints

form_GeneralName

check_GeneralNameChoice