Package org.xipki.ca.api.mgmt

Class 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.
 # Valid values depends on interval.hours:
 # -  1 hour:  any positive number
 # -  2 hours: 1, 2, 3, 4, 6, 12, 24, 36, ...(+12 = 24/2)
 # -  3 hours: 1, 2, 4,        8, 16, 24, ...(+8  = 24/3)
 # -  4 hours: 1, 2, 3,        6, 12, 18, ...(+6  = 24/4)
 # -  6 hours: 1, 2,           4,  8, 12, ...(+4  = 24/6)
 # -  8 hours: 1,              3,  6,  9, ...(+3  = 24/8)
 # - 12 hours: 1,              2,  4,  6, ...(+2  = 24/12)
 # - 24 hours: any positive number

 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
 #
 # Valid values depends on interval.hours:
 # -  1 hour:  any positive number
 # -  2 hours: 1, 2, 3, 4, 6, 12, 24, 36, ...(+12 = 24/2)
 # -  3 hours: 1, 2, 4,        8, 16, 24, ...(+8  = 24/3)
 # -  4 hours: 1, 2, 3,        6, 12, 18, ...(+6  = 24/4)
 # -  6 hours: 1, 2,           4,  8, 12, ...(+4  = 24/6)
 # -  8 hours: 1,              3,  6,  9, ...(+3  = 24/8)
 # - 12 hours: 1,              2,  4,  6, ...(+2  = 24/12)
 # - 24 hours: any positive number
 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.
 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 (xipki)

    • 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​(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()

      • 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