org.xipki.ca.api.mgmt

Class CrlControl

java.lang.Object

org.xipki.ca.api.mgmt.CrlControl

public class CrlControl
extends Object

CRL control.

 Example configuration

 # List of OIDs of extensions to be embedded in CRL,
 # Unspecified or empty extensions indicates that the CA decides.
 extensions=<comma delimited OIDs of extensions>

 # The following settings are only for updateMode 'interval'

 # Days between two full CRLs. Default is 1.
 # Should be greater than 0
 fullcrl.intervals=<integer>

 # Elapsed days before a deltaCRL is generated since the last CRL or deltaCRL.
 # Should be 0 or a positive integer less than fullcrl.intervals. Default is 0.
 # 0 indicates that no deltaCRL will be generated
 deltacrl.intervals=<integer>

 # Overlap days. At least 1 day
 overlap.days=<days of overlap>

 # UTC time of generation of CRL, one interval covers 1 day. Default is 01:00
 interval.time=<update time (hh:mm of UTC time)>

 # If set to true, the nextUpdate of a fullCRL is set to the update time of the next fullCRL.
 # otherwise set to that of the next CRL (fullCRL or deltaCRL)
 # Default is false
 fullcrl.extended.nextupdate=<'true'|'false'>

 # Whether Revocation reason is contained in CRL
 # Default is false
 exclude.reason=<'true'|'false'>

 # How the CRL entry extension invalidityDate is considered in CRL
 # Default is false
 invalidity.date=<'required'|'optional'|'forbidden'>

 # Whether to include the expired certificates
 # Default is false
 include.expiredcerts=<'true'|'false'>

 

Since:

2.0.0

Author:

Lijun Liao

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CrlControl.HourMinute

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DELTACRL_INTERVALS
static String	KEY_EXCLUDE_REASON
static String	KEY_EYTENSIONS
static String	KEY_FULLCRL_EXTENDED_NEXTUPDATE
static String	KEY_FULLCRL_INTERVALS
static String	KEY_INCLUDE_EXPIREDCERTS
static String	KEY_INTERVAL_TIME
static String	KEY_INVALIDITY_DATE
static String	KEY_OVERLAP_DAYS
static String	KEY_OVERLAP_MINUTES Deprecated. use KEY_OVERLAP_DAYS instead.

Constructor Summary

Constructors

Constructor and Description
CrlControl(String conf)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getConf()
int	getDeltaCrlIntervals()
Set<String>	getExtensionOids()
int	getFullCrlIntervals()
CrlControl.HourMinute	getIntervalDayTime()
org.xipki.util.TripleState	getInvalidityDateMode()
int	getOverlapDays()
int	hashCode()
boolean	isExcludeReason()
boolean	isExtendedNextUpdate()
boolean	isIncludeExpiredcerts()
String	toString()
String	toString(boolean verbose)
void	validate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY_EYTENSIONS

public static final String KEY_EYTENSIONS

See Also:

Constant Field Values

KEY_FULLCRL_INTERVALS

public static final String KEY_FULLCRL_INTERVALS

See Also:

Constant Field Values

KEY_DELTACRL_INTERVALS

public static final String KEY_DELTACRL_INTERVALS

See Also:

Constant Field Values

KEY_OVERLAP_MINUTES

public static final String KEY_OVERLAP_MINUTES

Deprecated. use KEY_OVERLAP_DAYS instead.

Overlap in minutes.

See Also:

Constant Field Values

KEY_OVERLAP_DAYS

public static final String KEY_OVERLAP_DAYS

See Also:

Constant Field Values

KEY_INTERVAL_TIME

public static final String KEY_INTERVAL_TIME

See Also:

Constant Field Values

KEY_FULLCRL_EXTENDED_NEXTUPDATE

public static final String KEY_FULLCRL_EXTENDED_NEXTUPDATE

See Also:

Constant Field Values

KEY_EXCLUDE_REASON

public static final String KEY_EXCLUDE_REASON

See Also:

Constant Field Values

KEY_INCLUDE_EXPIREDCERTS

public static final String KEY_INCLUDE_EXPIREDCERTS

See Also:

Constant Field Values

KEY_INVALIDITY_DATE

public static final String KEY_INVALIDITY_DATE

See Also:

Constant Field Values

Constructor Detail

CrlControl

public CrlControl(String conf)
           throws org.xipki.util.InvalidConfException

Throws:

org.xipki.util.InvalidConfException

Method Detail

getConf

public String getConf()

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean verbose)

getFullCrlIntervals

public int getFullCrlIntervals()

getDeltaCrlIntervals

public int getDeltaCrlIntervals()

getOverlapDays

public int getOverlapDays()

getIntervalDayTime

public CrlControl.HourMinute getIntervalDayTime()

getExtensionOids

public Set<String> getExtensionOids()

isExtendedNextUpdate

public boolean isExtendedNextUpdate()

isExcludeReason

public boolean isExcludeReason()

isIncludeExpiredcerts

public boolean isIncludeExpiredcerts()

getInvalidityDateMode

public org.xipki.util.TripleState getInvalidityDateMode()

validate

public final void validate()
                    throws org.xipki.util.InvalidConfException

Throws:

org.xipki.util.InvalidConfException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object