Package com.netscape.certsrv.property
Class Descriptor
java.lang.Object
com.netscape.certsrv.property.Descriptor
- All Implemented Interfaces:
IDescriptor
,JSONSerializer
This interface represents a property descriptor. A descriptor
includes information that describe a property.
- Version:
- $Revision$, $Date$
-
Field Summary
FieldsModifier and TypeFieldDescriptionFields inherited from interface com.netscape.certsrv.property.IDescriptor
BOOLEAN, CERT_REQUEST, CERT_REQUEST_TYPE, CHOICE, DATE, DN, DUAL_KEYGEN_REQUEST, DUAL_KEYGEN_REQUEST_TYPE, EMAIL, ENC_KEYGEN_REQUEST, ENC_KEYGEN_REQUEST_TYPE, HIDDEN, IMAGE_URL, INTEGER, IP, KEYGEN_REQUEST, KEYGEN_REQUEST_TYPE, PASSWORD, PRETTY_PRINT, READONLY, SERVER_SIDE_KEYGEN_KEY_SIZE, SERVER_SIDE_KEYGEN_KEY_TYPE, SERVER_SIDE_KEYGEN_PKCS12, SERVER_SIDE_KEYGEN_REQUEST_TYPE, SIGN_KEYGEN_REQUEST, SIGN_KEYGEN_REQUEST_TYPE, STRING, STRING_LIST
Fields inherited from interface com.netscape.certsrv.util.JSONSerializer
logger
-
Constructor Summary
ConstructorsConstructorDescriptionDescriptor
(String syntax, String constraint, String defValue, String description) Constructs a descriptor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
static Descriptor
Constraint for the given syntax.Returns the default value of the property.getDescription
(Locale locale) Retrieves the description of the property.Returns the syntax of the property.int
hashCode()
void
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.netscape.certsrv.util.JSONSerializer
toJSON
-
Field Details
-
mSyntax
-
mConstraint
-
mDescription
-
mDef
-
-
Constructor Details
-
Descriptor
public Descriptor() -
Descriptor
Constructs a descriptor.- Parameters:
syntax
- syntaxconstraint
- constraintdefValue
- default valuedescription
- description
-
-
Method Details
-
getSyntax
Returns the syntax of the property.- Specified by:
getSyntax
in interfaceIDescriptor
- Returns:
- syntax
-
getDefaultValue
Returns the default value of the property.- Specified by:
getDefaultValue
in interfaceIDescriptor
- Returns:
- default value
-
getConstraint
Constraint for the given syntax. For example,- number(1-5): 1-5 is the constraint, and it indicates that the number must be in the range of 1 to 5.
- choice(cert,crl): cert,crl is the constraint for choice
If null, no constraint shall be enforced.
- Specified by:
getConstraint
in interfaceIDescriptor
- Returns:
- constraint
-
getDescription
Retrieves the description of the property.- Specified by:
getDescription
in interfaceIDescriptor
- Parameters:
locale
- user locale- Returns:
- description
-
hashCode
public int hashCode() -
equals
-
toDOM
-
toDOM
-
fromDOM
-