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

 # Whether expired certificates are considered. Default is false
 expiredcerts.included=<'true'|'false'>

 # Whether XiPKI-customized extension xipki-CrlCertSet is included. Default is false
 xipki.certset=<'true'|'false'>

 # Whether the extension xipki-CrlCertSet contains the raw certificates. Default is true
 xipki.certset.certs=<'true'|'false'>

 # Whether the extension xipki-CrlCertSet contains the profile name of the certificate.
 # Default is true
 xipki.certset.profilename=<'true'|'false'>

 # 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 minutes. At least 60 minutes
 overlap.minutes=<minutes 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 only user certificates are considered in CRL
 # Default is false
 user.certs.only=<'true'|'false'>

 # Whether only CA certificates are considered in CRL
 # Default if false
 ca.certs.only=<'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'>

 

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_EXPIRED_CERTS_INCLUDED
static String	KEY_EYTENSIONS
static String	KEY_FULLCRL_EXTENDED_NEXTUPDATE
static String	KEY_FULLCRL_INTERVALS
static String	KEY_INTERVAL_TIME
static String	KEY_INVALIDITY_DATE
static String	KEY_ONLY_CONTAINS_CACERTS
static String	KEY_ONLY_CONTAINS_USERCERTS
static String	KEY_OVERLAP_MINUTES
static String	KEY_XIPKI_CERTSET
static String	KEY_XIPKI_CERTSET_CERTS

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	getOverlapMinutes()
int	hashCode()
boolean	isExcludeReason()
boolean	isExtendedNextUpdate()
boolean	isIncludeExpiredCerts()
boolean	isOnlyContainsCaCerts()
boolean	isOnlyContainsUserCerts()
boolean	isXipkiCertsetCertIncluded()
boolean	isXipkiCertsetIncluded()
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_EXPIRED_CERTS_INCLUDED

public static final String KEY_EXPIRED_CERTS_INCLUDED

See Also:

Constant Field Values

KEY_XIPKI_CERTSET

public static final String KEY_XIPKI_CERTSET

See Also:

Constant Field Values

KEY_XIPKI_CERTSET_CERTS

public static final String KEY_XIPKI_CERTSET_CERTS

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

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_ONLY_CONTAINS_USERCERTS

public static final String KEY_ONLY_CONTAINS_USERCERTS

See Also:

Constant Field Values

KEY_ONLY_CONTAINS_CACERTS

public static final String KEY_ONLY_CONTAINS_CACERTS

See Also:

Constant Field Values

KEY_EXCLUDE_REASON

public static final String KEY_EXCLUDE_REASON

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)

isXipkiCertsetIncluded

public boolean isXipkiCertsetIncluded()

isXipkiCertsetCertIncluded

public boolean isXipkiCertsetCertIncluded()

isIncludeExpiredCerts

public boolean isIncludeExpiredCerts()

getFullCrlIntervals

public int getFullCrlIntervals()

getDeltaCrlIntervals

public int getDeltaCrlIntervals()

getOverlapMinutes

public int getOverlapMinutes()

getIntervalDayTime

public CrlControl.HourMinute getIntervalDayTime()

getExtensionOids

public Set<String> getExtensionOids()

isExtendedNextUpdate

public boolean isExtendedNextUpdate()

isOnlyContainsUserCerts

public boolean isOnlyContainsUserCerts()

isOnlyContainsCaCerts

public boolean isOnlyContainsCaCerts()

isExcludeReason

public boolean isExcludeReason()

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