Class Descriptor

java.lang.Object

com.netscape.certsrv.property.Descriptor

All Implemented Interfaces:

IDescriptor, JSONSerializer

public class Descriptor
extends Object
implements IDescriptor, JSONSerializer

This interface represents a property descriptor. A descriptor includes information that describe a property.

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field	Description
String	mConstraint
String	mDef
String	mDescription
String	mSyntax

Fields 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

Constructor Summary

Constructors

Constructor	Description
Descriptor()
Descriptor(String syntax, String constraint, String defValue, String description)	Constructs a descriptor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Descriptor	fromDOM(Element element)
String	getConstraint()	Constraint for the given syntax.
String	getDefaultValue()	Returns the default value of the property.
String	getDescription(Locale locale)	Retrieves the description of the property.
String	getSyntax()	Returns the syntax of the property.
int	hashCode()
Element	toDOM(Document document)
void	toDOM(Document document, Element element)

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

public String mSyntax

mConstraint

public String mConstraint

mDescription

public String mDescription

mDef

public String mDef

Constructor Details

Descriptor

public Descriptor()

Descriptor

public Descriptor(String syntax,
 String constraint,
 String defValue,
 String description)

Constructs a descriptor.

Parameters:

syntax - syntax

constraint - constraint

defValue - default value

description - description

Method Details

getSyntax

public String getSyntax()

Returns the syntax of the property.

Specified by:

getSyntax in interface IDescriptor

Returns:

syntax

getDefaultValue

public String getDefaultValue()

Returns the default value of the property.

Specified by:

getDefaultValue in interface IDescriptor

Returns:

default value

getConstraint

public String 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 interface IDescriptor

Returns:

constraint

getDescription

public String getDescription(Locale locale)

Retrieves the description of the property.

Specified by:

getDescription in interface IDescriptor

Parameters:

locale - user locale

Returns:

description

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toDOM

public void toDOM(Document document,
 Element element)

toDOM

public Element toDOM(Document document)

fromDOM

public static Descriptor fromDOM(Element element)