Class EnrollConstraint
- java.lang.Object
-
- com.netscape.cms.profile.constraint.PolicyConstraint
-
- com.netscape.cms.profile.constraint.EnrollConstraint
-
- All Implemented Interfaces:
IConfigTemplate
- Direct Known Subclasses:
AuthzRealmConstraint
,BasicConstraintsExtConstraint
,ExtendedKeyUsageExtConstraint
,ExtensionConstraint
,ExternalProcessConstraint
,KeyConstraint
,KeyUsageExtConstraint
,NSCertTypeExtConstraint
,RenewGracePeriodConstraint
,SubjectNameConstraint
,UserSubjectNameConstraint
public abstract class EnrollConstraint extends PolicyConstraint
This class implements the generic enrollment constraint.- Version:
- $Revision$, $Date$
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CONFIG_NAME
static java.lang.String
CONFIG_PARAMS
static org.slf4j.Logger
logger
protected IConfigStore
mConfig
protected 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 void
addConfigName(java.lang.String name)
protected boolean
getBoolean(java.lang.String value)
java.lang.String
getConfig(java.lang.String name)
Retrieves configuration parameter by name.java.lang.String
getConfig(java.lang.String name, java.lang.String defval)
Get constraint parameter in profile configuration.protected boolean
getConfigBoolean(java.lang.String value)
IDescriptor
getConfigDescriptor(java.util.Locale locale, java.lang.String name)
Returns the descriptors of configuration parameter.protected int
getConfigInt(java.lang.String value)
java.util.Enumeration<java.lang.String>
getConfigNames()
Returns a list of configuration parameter names.IConfigStore
getConfigStore()
Returns the corresponding configuration store of this constraint policy.protected org.mozilla.jss.netscape.security.x509.Extension
getExtension(java.lang.String name, org.mozilla.jss.netscape.security.x509.X509CertInfo info)
protected int
getInt(java.lang.String value)
java.util.Locale
getLocale(IRequest request)
java.lang.String
getName(java.util.Locale locale)
Returns localized name of this constraint.java.lang.String
getText(java.util.Locale locale)
Returns localized description of this constraint.IDescriptor
getValueDescriptor(java.util.Locale locale, java.lang.String name)
void
init(IConfigStore config)
Initializes this constraint policy.boolean
isApplicable(PolicyDefault def)
Checks if this constraint is applicable to the given default policy.protected boolean
isOptional(java.lang.String value)
void
setConfig(java.lang.String name, java.lang.String value)
Sets configuration parameter.void
validate(IRequest request)
Validates the request.abstract void
validate(IRequest request, org.mozilla.jss.netscape.security.x509.X509CertInfo info)
Validates the request.
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
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:IConfigTemplate
Returns a list of configuration parameter names.- 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:IConfigTemplate
Returns the descriptors of configuration parameter.- 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 EPropertyException
Description copied from interface:IConfigTemplate
Sets configuration parameter.- 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:IConfigTemplate
Retrieves configuration parameter by name.- 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(IConfigStore config) throws EProfileException
Description copied from class:PolicyConstraint
Initializes this constraint policy.- Specified by:
init
in classPolicyConstraint
- Parameters:
config
- configuration store for this constraint- Throws:
EProfileException
- failed to initialize
-
getConfigStore
public IConfigStore getConfigStore()
Description copied from class:PolicyConstraint
Returns the corresponding configuration store of this constraint policy.- Specified by:
getConfigStore
in classPolicyConstraint
- Returns:
- config store of this constraint
-
validate
public abstract void validate(IRequest request, org.mozilla.jss.netscape.security.x509.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:
validate
in classPolicyConstraint
- 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 class:PolicyConstraint
Returns localized description of this constraint.- Specified by:
getText
in classPolicyConstraint
- 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 class:PolicyConstraint
Returns localized name of this constraint.- Specified by:
getName
in classPolicyConstraint
- Parameters:
locale
- locale of the end-user- Returns:
- localized name of this constraint
-
getExtension
protected org.mozilla.jss.netscape.security.x509.Extension getExtension(java.lang.String name, org.mozilla.jss.netscape.security.x509.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(PolicyDefault def)
Description copied from class:PolicyConstraint
Checks if this constraint is applicable to the given default policy.- Specified by:
isApplicable
in classPolicyConstraint
- Parameters:
def
- default policy to be checked- Returns:
- true if this constraint can be applied to the given default policy
-
-