Class EnrollConstraint
- java.lang.Object
-
- com.netscape.cms.profile.constraint.EnrollConstraint
-
- All Implemented Interfaces:
IPolicyConstraint,IConfigTemplate
- Direct Known Subclasses:
AuthzRealmConstraint,BasicConstraintsExtConstraint,CAEnrollConstraint,CMCSelfSignedSubjectNameConstraint,CMCUserSignedSubjectNameConstraint,ExtendedKeyUsageExtConstraint,ExtensionConstraint,ExternalProcessConstraint,KeyConstraint,KeyUsageExtConstraint,NSCertTypeExtConstraint,RenewGracePeriodConstraint,SigningAlgConstraint,SubjectNameConstraint,UniqueKeyConstraint,UniqueSubjectNameConstraint,UserSubjectNameConstraint,ValidityConstraint
public abstract class EnrollConstraint extends java.lang.Object implements IPolicyConstraint
This class implements the generic enrollment constraint.- Version:
- $Revision$, $Date$
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringCONFIG_NAMEstatic java.lang.StringCONFIG_PARAMSprotected IConfigStoremConfigprotected java.util.Vector<java.lang.String>mConfigNames
-
Constructor Summary
Constructors Constructor Description EnrollConstraint()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddConfigName(java.lang.String name)protected booleangetBoolean(java.lang.String value)java.lang.StringgetConfig(java.lang.String name)Retrieves configuration parameter by name.java.lang.StringgetConfig(java.lang.String name, java.lang.String defval)Get constraint parameter in profile configuration.protected booleangetConfigBoolean(java.lang.String value)IDescriptorgetConfigDescriptor(java.util.Locale locale, java.lang.String name)Returns the descriptors of configuration parameter.protected intgetConfigInt(java.lang.String value)java.util.Enumeration<java.lang.String>getConfigNames()Returns a list of configuration parameter names.IConfigStoregetConfigStore()Returns the corresponding configuration store of this constraint policy.protected ExtensiongetExtension(java.lang.String name, X509CertInfo info)protected intgetInt(java.lang.String value)java.util.LocalegetLocale(IRequest request)java.lang.StringgetName(java.util.Locale locale)Returns localized name of this constraint.java.lang.StringgetText(java.util.Locale locale)Returns localized description of this constraint.IDescriptorgetValueDescriptor(java.util.Locale locale, java.lang.String name)voidinit(IProfile profile, IConfigStore config)Initializes this constraint policy.booleanisApplicable(IPolicyDefault def)Checks if this constraint is applicable to the given default policy.protected booleanisOptional(java.lang.String value)voidsetConfig(java.lang.String name, java.lang.String value)Sets configuration parameter.voidvalidate(IRequest request)Validates the request.abstract voidvalidate(IRequest request, X509CertInfo info)Validates the request.
-
-
-
Field Detail
-
CONFIG_NAME
public static final java.lang.String CONFIG_NAME
- See Also:
- Constant Field Values
-
CONFIG_PARAMS
public static final java.lang.String CONFIG_PARAMS
- See Also:
- Constant Field Values
-
mConfig
protected IConfigStore mConfig
-
mConfigNames
protected java.util.Vector<java.lang.String> mConfigNames
-
-
Method Detail
-
getConfigNames
public java.util.Enumeration<java.lang.String> getConfigNames()
Description copied from interface:IConfigTemplateReturns a list of configuration parameter names.- Specified by:
getConfigNamesin interfaceIConfigTemplate- Returns:
- parameter names
-
addConfigName
public void addConfigName(java.lang.String name)
-
getConfigDescriptor
public IDescriptor getConfigDescriptor(java.util.Locale locale, java.lang.String name)
Description copied from interface:IConfigTemplateReturns the descriptors of configuration parameter.- Specified by:
getConfigDescriptorin interfaceIConfigTemplate- Parameters:
locale- user localename- configuration parameter name- Returns:
- descriptor
-
getValueDescriptor
public IDescriptor getValueDescriptor(java.util.Locale locale, java.lang.String name)
-
getLocale
public java.util.Locale getLocale(IRequest request)
-
setConfig
public void setConfig(java.lang.String name, java.lang.String value) throws EPropertyExceptionDescription copied from interface:IConfigTemplateSets configuration parameter.- Specified by:
setConfigin interfaceIConfigTemplate- Parameters:
name- parameter namevalue- parameter value- Throws:
EPropertyException- failed to set parameter
-
getConfig
public java.lang.String getConfig(java.lang.String name)
Description copied from interface:IConfigTemplateRetrieves configuration parameter by name.- Specified by:
getConfigin interfaceIConfigTemplate- Returns:
- parameter
-
getConfig
public java.lang.String getConfig(java.lang.String name, java.lang.String defval)Get constraint parameter in profile configuration.- Parameters:
name- parameter namedefval- default value if parameter does not exist- Returns:
- parameter value if exists, defval if does not exist, or null if error occured
-
init
public void init(IProfile profile, IConfigStore config) throws EProfileException
Description copied from interface:IPolicyConstraintInitializes this constraint policy.- Specified by:
initin interfaceIPolicyConstraint- Parameters:
profile- owner of this policyconfig- configuration store for this constraint- Throws:
EProfileException- failed to initialize
-
getConfigStore
public IConfigStore getConfigStore()
Description copied from interface:IPolicyConstraintReturns the corresponding configuration store of this constraint policy.- Specified by:
getConfigStorein interfaceIPolicyConstraint- Returns:
- config store of this constraint
-
validate
public abstract void validate(IRequest request, X509CertInfo info) throws ERejectException
Validates the request. The request is not modified during the validation.- Parameters:
request- enrollment requestinfo- certificate template- Throws:
ERejectException- request is rejected due to violation of constraint
-
validate
public void validate(IRequest request) throws ERejectException
Validates the request. The request is not modified during the validation. The current implementation of this method calls into the subclass's validate(request, info) method for validation checking.- Specified by:
validatein interfaceIPolicyConstraint- Parameters:
request- request- Throws:
ERejectException- request is rejected due to violation of constraint
-
getText
public java.lang.String getText(java.util.Locale locale)
Description copied from interface:IPolicyConstraintReturns localized description of this constraint.- Specified by:
getTextin interfaceIPolicyConstraint- Parameters:
locale- locale of the end-user- Returns:
- localized description of this constraint
-
getName
public java.lang.String getName(java.util.Locale locale)
Description copied from interface:IPolicyConstraintReturns localized name of this constraint.- Specified by:
getNamein interfaceIPolicyConstraint- Parameters:
locale- locale of the end-user- Returns:
- localized name of this constraint
-
getExtension
protected Extension getExtension(java.lang.String name, X509CertInfo info)
-
isOptional
protected boolean isOptional(java.lang.String value)
-
getBoolean
protected boolean getBoolean(java.lang.String value)
-
getInt
protected int getInt(java.lang.String value)
-
getConfigBoolean
protected boolean getConfigBoolean(java.lang.String value)
-
getConfigInt
protected int getConfigInt(java.lang.String value)
-
isApplicable
public boolean isApplicable(IPolicyDefault def)
Description copied from interface:IPolicyConstraintChecks if this constraint is applicable to the given default policy.- Specified by:
isApplicablein interfaceIPolicyConstraint- Parameters:
def- default policy to be checked- Returns:
- true if this constraint can be applied to the given default policy
-
-