IDescriptor (pki-common)

All Known Implementing Classes:

Descriptor
```
public interface IDescriptor
```
This interface represents a property descriptor.

Version:

$Revision$, $Date$

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BOOLEAN`
`static java.lang.String`	`CERT_REQUEST`
`static java.lang.String`	`CERT_REQUEST_TYPE`
`static java.lang.String`	`CHOICE`
`static java.lang.String`	`DATE`
`static java.lang.String`	`DN`
`static java.lang.String`	`DUAL_KEYGEN_REQUEST`
`static java.lang.String`	`DUAL_KEYGEN_REQUEST_TYPE`
`static java.lang.String`	`EMAIL`
`static java.lang.String`	`ENC_KEYGEN_REQUEST`
`static java.lang.String`	`ENC_KEYGEN_REQUEST_TYPE`
`static java.lang.String`	`HIDDEN`
`static java.lang.String`	`IMAGE_URL`
`static java.lang.String`	`INTEGER`
`static java.lang.String`	`IP`
`static java.lang.String`	`KEYGEN_REQUEST`
`static java.lang.String`	`KEYGEN_REQUEST_TYPE`
`static java.lang.String`	`PASSWORD`
`static java.lang.String`	`PRETTY_PRINT`
`static java.lang.String`	`READONLY`
`static java.lang.String`	`SIGN_KEYGEN_REQUEST`
`static java.lang.String`	`SIGN_KEYGEN_REQUEST_TYPE`
`static java.lang.String`	`STRING`
`static java.lang.String`	`STRING_LIST`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getConstraint()` Constraint for the given syntax.
`java.lang.String`	`getDefaultValue()` Retrieves the default value of the property.
`java.lang.String`	`getDescription(java.util.Locale locale)` Retrieves the description of the property.
`java.lang.String`	`getSyntax()` Returns the syntax of the property.

- Field Detail
  - DATE
```
static final java.lang.String DATE
```
    See Also:
    Constant Field Values
  - PASSWORD
```
static final java.lang.String PASSWORD
```
    See Also:
    Constant Field Values
  - PRETTY_PRINT
```
static final java.lang.String PRETTY_PRINT
```
    See Also:
    Constant Field Values
  - IMAGE_URL
```
static final java.lang.String IMAGE_URL
```
    See Also:
    Constant Field Values
  - INTEGER
```
static final java.lang.String INTEGER
```
    See Also:
    Constant Field Values
  - BOOLEAN
```
static final java.lang.String BOOLEAN
```
    See Also:
    Constant Field Values
  - STRING
```
static final java.lang.String STRING
```
    See Also:
    Constant Field Values
  - STRING_LIST
```
static final java.lang.String STRING_LIST
```
    See Also:
    Constant Field Values
  - KEYGEN_REQUEST
```
static final java.lang.String KEYGEN_REQUEST
```
    See Also:
    Constant Field Values
  - KEYGEN_REQUEST_TYPE
```
static final java.lang.String KEYGEN_REQUEST_TYPE
```
    See Also:
    Constant Field Values
  - ENC_KEYGEN_REQUEST
```
static final java.lang.String ENC_KEYGEN_REQUEST
```
    See Also:
    Constant Field Values
  - ENC_KEYGEN_REQUEST_TYPE
```
static final java.lang.String ENC_KEYGEN_REQUEST_TYPE
```
    See Also:
    Constant Field Values
  - SIGN_KEYGEN_REQUEST
```
static final java.lang.String SIGN_KEYGEN_REQUEST
```
    See Also:
    Constant Field Values
  - SIGN_KEYGEN_REQUEST_TYPE
```
static final java.lang.String SIGN_KEYGEN_REQUEST_TYPE
```
    See Also:
    Constant Field Values
  - DUAL_KEYGEN_REQUEST
```
static final java.lang.String DUAL_KEYGEN_REQUEST
```
    See Also:
    Constant Field Values
  - DUAL_KEYGEN_REQUEST_TYPE
```
static final java.lang.String DUAL_KEYGEN_REQUEST_TYPE
```
    See Also:
    Constant Field Values
  - CERT_REQUEST
```
static final java.lang.String CERT_REQUEST
```
    See Also:
    Constant Field Values
  - CERT_REQUEST_TYPE
```
static final java.lang.String CERT_REQUEST_TYPE
```
    See Also:
    Constant Field Values
  - CHOICE
```
static final java.lang.String CHOICE
```
    See Also:
    Constant Field Values
  - DN
```
static final java.lang.String DN
```
    See Also:
    Constant Field Values
  - IP
```
static final java.lang.String IP
```
    See Also:
    Constant Field Values
  - EMAIL
```
static final java.lang.String EMAIL
```
    See Also:
    Constant Field Values
  - READONLY
```
static final java.lang.String READONLY
```
    See Also:
    Constant Field Values
  - HIDDEN
```
static final java.lang.String HIDDEN
```
    See Also:
    Constant Field Values
- Method Detail
  - getSyntax
```
java.lang.String getSyntax()
```
    Returns the syntax of the property.
    
    Returns:
    syntax
  - getConstraint
```
java.lang.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.
    
    Returns:
    constraint
  - getDescription
```
java.lang.String getDescription(java.util.Locale locale)
```
    Retrieves the description of the property.
    
    Parameters:
    locale - user locale
    
    Returns:
    localized description
  - getDefaultValue
```
java.lang.String getDefaultValue()
```
    Retrieves the default value of the property.
    
    Returns:
    default value

Interface IDescriptor

Field Summary

Method Summary

Field Detail

DATE

PASSWORD

PRETTY_PRINT

IMAGE_URL

INTEGER

BOOLEAN

STRING

STRING_LIST

KEYGEN_REQUEST

KEYGEN_REQUEST_TYPE

ENC_KEYGEN_REQUEST

ENC_KEYGEN_REQUEST_TYPE

SIGN_KEYGEN_REQUEST

SIGN_KEYGEN_REQUEST_TYPE

DUAL_KEYGEN_REQUEST

DUAL_KEYGEN_REQUEST_TYPE

CERT_REQUEST

CERT_REQUEST_TYPE

CHOICE

DN

IP

EMAIL

READONLY

HIDDEN

Method Detail

getSyntax

getConstraint

getDescription

getDefaultValue