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

 # The following settings are only for updateMode 'interval'

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

 # Elapsed intervals 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 time, unit is m (minutes), h (hour), d (day), w (week), y (year).
 overlap=<integer><unit>

 # Interval period in hours, valid values are 1, 2, 3, 4, 6, 8, 12 and 24.
 #
 # Default is 24.
 interval.hours=<integer>

 # UTC time at which CRL is generated, Default is 01:00.
 # If day.intervals is greater than 1, this specifies only one of the generation times.
 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 optional
 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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CrlControl(org.xipki.util.ConfPairs props)
CrlControl(String conf)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getConf()
org.xipki.util.ConfPairs	getConfPairs()
int	getDeltaCrlIntervals()
int	getFullCrlIntervals()
org.xipki.util.HourMinute	getIntervalDayTime()
int	getIntervalHours()
long	getIntervalMillis()
org.xipki.util.TripleState	getInvalidityDateMode()
org.xipki.util.Validity	getOverlap()
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_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 instead.

Overlap in minutes.

See Also:

Constant Field Values

KEY_OVERLAP_DAYS

public static final String KEY_OVERLAP_DAYS

Deprecated. use KEY_OVERLAP instead.

Overlap in days.

See Also:

Constant Field Values

KEY_OVERLAP

public static final String KEY_OVERLAP

Overlap.

See Also:

Constant Field Values

KEY_INTERVAL_HOURS

public static final String KEY_INTERVAL_HOURS

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.exception.InvalidConfException

Throws:

org.xipki.util.exception.InvalidConfException

CrlControl

public CrlControl(org.xipki.util.ConfPairs props)
           throws org.xipki.util.exception.InvalidConfException

Throws:

org.xipki.util.exception.InvalidConfException

Method Detail

getConf

public String getConf()

getConfPairs

public org.xipki.util.ConfPairs getConfPairs()

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean verbose)

getFullCrlIntervals

public int getFullCrlIntervals()

getDeltaCrlIntervals

public int getDeltaCrlIntervals()

getOverlap

public org.xipki.util.Validity getOverlap()

getIntervalDayTime

public org.xipki.util.HourMinute getIntervalDayTime()

isExtendedNextUpdate

public boolean isExtendedNextUpdate()

isExcludeReason

public boolean isExcludeReason()

isIncludeExpiredcerts

public boolean isIncludeExpiredcerts()

getInvalidityDateMode

public org.xipki.util.TripleState getInvalidityDateMode()

getIntervalHours

public int getIntervalHours()

getIntervalMillis

public long getIntervalMillis()

validate

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

Throws:

org.xipki.util.exception.InvalidConfException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object