diff options
Diffstat (limited to 'base/common/src/com/netscape/certsrv/ca/ICRLIssuingPoint.java')
| -rw-r--r-- | base/common/src/com/netscape/certsrv/ca/ICRLIssuingPoint.java | 118 |
1 files changed, 59 insertions, 59 deletions
diff --git a/base/common/src/com/netscape/certsrv/ca/ICRLIssuingPoint.java b/base/common/src/com/netscape/certsrv/ca/ICRLIssuingPoint.java index f317db9b1..80a579cca 100644 --- a/base/common/src/com/netscape/certsrv/ca/ICRLIssuingPoint.java +++ b/base/common/src/com/netscape/certsrv/ca/ICRLIssuingPoint.java @@ -44,7 +44,7 @@ import com.netscape.certsrv.dbs.IElementProcessor; * can also be triggered by invoking updateCRL method directly. Another * parameter minUpdateInterval can be used to prevent CRL * from being updated too often - * + * * @version $Revision$, $Date$ */ @@ -73,98 +73,98 @@ public interface ICRLIssuingPoint { /** * Returns true if CRL issuing point is enabled. - * + * * @return true if CRL issuing point is enabled */ public boolean isCRLIssuingPointEnabled(); /** * Returns true if CRL generation is enabled. - * + * * @return true if CRL generation is enabled */ public boolean isCRLGenerationEnabled(); /** * Enables or disables CRL issuing point according to parameter. - * + * * @param enable if true enables CRL issuing point */ public void enableCRLIssuingPoint(boolean enable); /** * Returns CRL update status. - * + * * @return CRL update status */ public String getCrlUpdateStatusStr(); /** * Returns CRL update error. - * + * * @return CRL update error */ public String getCrlUpdateErrorStr(); /** * Returns CRL publishing status. - * + * * @return CRL publishing status */ public String getCrlPublishStatusStr(); /** * Returns CRL publishing error. - * + * * @return CRL publishing error */ public String getCrlPublishErrorStr(); /** * Returns CRL issuing point initialization status. - * + * * @return status of CRL issuing point initialization */ public int isCRLIssuingPointInitialized(); /** * Checks if manual update is set. - * + * * @return true if manual update is set */ public boolean isManualUpdateSet(); /** * Checks if expired certificates are included in CRL. - * + * * @return true if expired certificates are included in CRL */ public boolean areExpiredCertsIncluded(); /** * Checks if CRL includes CA certificates only. - * + * * @return true if CRL includes CA certificates only */ public boolean isCACertsOnly(); /** * Checks if CRL includes profile certificates only. - * + * * @return true if CRL includes profile certificates only */ public boolean isProfileCertsOnly(); /** * Checks if CRL issuing point includes this profile. - * + * * @return true if CRL issuing point includes this profile */ public boolean checkCurrentProfile(String id); /** * Initializes CRL issuing point. - * + * * @param ca certificate authority that holds CRL issuing point * @param id CRL issuing point id * @param config configuration sub-store for CRL issuing point @@ -181,21 +181,21 @@ public interface ICRLIssuingPoint { /** * Returns internal id of this CRL issuing point. - * + * * @return internal id of this CRL issuing point */ public String getId(); /** * Returns internal description of this CRL issuing point. - * + * * @return internal description of this CRL issuing point */ public String getDescription(); /** * Sets internal description of this CRL issuing point. - * + * * @param description description for this CRL issuing point. */ public void setDescription(String description); @@ -203,21 +203,21 @@ public interface ICRLIssuingPoint { /** * Returns DN of the directory entry where CRLs from this issuing point * are published. - * + * * @return DN of the directory entry where CRLs are published. */ public String getPublishDN(); /** * Returns signing algorithm. - * + * * @return signing algorithm */ public String getSigningAlgorithm(); /** * Returns signing algorithm used in last signing operation.. - * + * * @return last signing algorithm */ public String getLastSigningAlgorithm(); @@ -225,14 +225,14 @@ public interface ICRLIssuingPoint { /** * Returns current CRL generation schema for this CRL issuing point. * <P> - * + * * @return current CRL generation schema for this CRL issuing point */ public int getCRLSchema(); /** * Returns current CRL number of this CRL issuing point. - * + * * @return current CRL number of this CRL issuing point */ public BigInteger getCRLNumber(); @@ -240,56 +240,56 @@ public interface ICRLIssuingPoint { /** * Returns current delta CRL number of this CRL issuing point. * <P> - * + * * @return current delta CRL number of this CRL issuing point */ public BigInteger getDeltaCRLNumber(); /** * Returns next CRL number of this CRL issuing point. - * + * * @return next CRL number of this CRL issuing point */ public BigInteger getNextCRLNumber(); /** * Returns number of entries in the current CRL. - * + * * @return number of entries in the current CRL */ public long getCRLSize(); /** * Returns number of entries in delta CRL - * + * * @return number of entries in delta CRL */ public long getDeltaCRLSize(); /** * Returns time of the last update. - * + * * @return last CRL update time */ public Date getLastUpdate(); /** * Returns time of the next update. - * + * * @return next CRL update time */ public Date getNextUpdate(); /** * Returns time of the next delta CRL update. - * + * * @return next delta CRL update time */ public Date getNextDeltaUpdate(); /** * Returns all the revoked certificates from the CRL cache. - * + * * @param start first requested CRL entry * @param end next after last requested CRL entry * @return set of all the revoked certificates or null if there are none. @@ -298,7 +298,7 @@ public interface ICRLIssuingPoint { /** * Returns certificate authority. - * + * * @return certificate authority */ public ISubsystem getCertificateAuthority(); @@ -306,14 +306,14 @@ public interface ICRLIssuingPoint { /** * Schedules immediate CRL manual-update * and sets signature algorithm to be used for signing. - * + * * @param signatureAlgorithm signature algorithm to be used for signing */ public void setManualUpdate(String signatureAlgorithm); /** * Returns auto update interval in milliseconds. - * + * * @return auto update interval in milliseconds */ public long getAutoUpdateInterval(); @@ -321,14 +321,14 @@ public interface ICRLIssuingPoint { /** * Returns true if CRL is updated for every change * of revocation status of any certificate. - * + * * @return true if CRL update is always triggered by revocation operation */ public boolean getAlwaysUpdate(); /** * Returns next update grace period in minutes. - * + * * @return next update grace period in minutes */ public long getNextUpdateGracePeriod(); @@ -336,7 +336,7 @@ public interface ICRLIssuingPoint { /** * Returns filter used to build CRL based on information stored * in local directory. - * + * * @return filter used to search local directory */ public String getFilter(); @@ -346,7 +346,7 @@ public interface ICRLIssuingPoint { * Calls certificate record processor to get necessary data * from certificate records. * This also regenerates CRL cache. - * + * * @param cp certificate record processor * @exception EBaseException if an error occurred in the database. */ @@ -356,7 +356,7 @@ public interface ICRLIssuingPoint { /** * Returns date of revoked certificate or null * if certificated is not listed as revoked. - * + * * @param serialNumber serial number of certificate to be checked * @param checkDeltaCache true if delta CRL cache suppose to be * included in checking process @@ -370,7 +370,7 @@ public interface ICRLIssuingPoint { /** * Returns split times from CRL generation. - * + * * @return split times from CRL generation in milliseconds */ public Vector<Long> getSplitTimes(); @@ -378,7 +378,7 @@ public interface ICRLIssuingPoint { /** * Generates CRL now based on cache or local directory if cache * is not available. It also publishes CRL if it is required. - * + * * @param signingAlgorithm signing algorithm to be used for CRL signing * @exception EBaseException if an error occurred during * CRL generation or publishing @@ -398,21 +398,21 @@ public interface ICRLIssuingPoint { /** * Returns number of recently revoked certificates. - * + * * @return number of recently revoked certificates */ public int getNumberOfRecentlyRevokedCerts(); /** * Returns number of recently unrevoked certificates. - * + * * @return number of recently unrevoked certificates */ public int getNumberOfRecentlyUnrevokedCerts(); /** * Returns number of recently expired and revoked certificates. - * + * * @return number of recently expired and revoked certificates */ public int getNumberOfRecentlyExpiredCerts(); @@ -420,7 +420,7 @@ public interface ICRLIssuingPoint { /** * Converts list of extensions supplied by revocation request * to list of extensions required to be placed in CRL. - * + * * @param exts list of extensions supplied by revocation request * @return list of extensions required to be placed in CRL */ @@ -428,7 +428,7 @@ public interface ICRLIssuingPoint { /** * Adds revoked certificate to delta-CRL cache. - * + * * @param serialNumber serial number of revoked certificate * @param revokedCert revocation information supplied by revocation request */ @@ -436,7 +436,7 @@ public interface ICRLIssuingPoint { /** * Adds revoked certificate to delta-CRL cache. - * + * * @param serialNumber serial number of revoked certificate * @param revokedCert revocation information supplied by revocation request * @param requestId revocation request id @@ -446,14 +446,14 @@ public interface ICRLIssuingPoint { /** * Adds unrevoked certificate to delta-CRL cache. - * + * * @param serialNumber serial number of unrevoked certificate */ public void addUnrevokedCert(BigInteger serialNumber); /** * Adds unrevoked certificate to delta-CRL cache. - * + * * @param serialNumber serial number of unrevoked certificate * @param requestId unrevocation request id */ @@ -461,7 +461,7 @@ public interface ICRLIssuingPoint { /** * Adds expired and revoked certificate to delta-CRL cache. - * + * * @param serialNumber serial number of expired and revoked certificate */ public void addExpiredCert(BigInteger serialNumber); @@ -474,7 +474,7 @@ public interface ICRLIssuingPoint { /** * Updates issuing point configuration according to supplied data * in name value pairs. - * + * * @param params name value pairs defining new issuing point configuration * @return true if configuration is updated successfully */ @@ -482,35 +482,35 @@ public interface ICRLIssuingPoint { /** * Returns true if delta-CRL is enabled. - * + * * @return true if delta-CRL is enabled */ public boolean isDeltaCRLEnabled(); /** * Returns true if CRL cache is enabled. - * + * * @return true if CRL cache is enabled */ public boolean isCRLCacheEnabled(); /** * Returns true if CRL cache is empty. - * + * * @return true if CRL cache is empty */ public boolean isCRLCacheEmpty(); /** * Returns true if CRL cache testing is enabled. - * + * * @return true if CRL cache testing is enabled */ public boolean isCRLCacheTestingEnabled(); /** * Returns true if supplied delta-CRL is matching current delta-CRL. - * + * * @param deltaCRL delta-CRL to verify against current delta-CRL * @return true if supplied delta-CRL is matching current delta-CRL */ @@ -518,7 +518,7 @@ public interface ICRLIssuingPoint { /** * Returns status of CRL generation. - * + * * @return one of the following according to CRL generation status: * CRL_UPDATE_DONE, CRL_UPDATE_STARTED, and CRL_PUBLISHING_STARTED */ @@ -528,7 +528,7 @@ public interface ICRLIssuingPoint { * Generates CRL now based on cache or local directory if cache * is not available. It also publishes CRL if it is required. * CRL is signed by default signing algorithm. - * + * * @exception EBaseException if an error occurred during * CRL generation or publishing */ @@ -536,7 +536,7 @@ public interface ICRLIssuingPoint { /** * Returns list of CRL extensions. - * + * * @return list of CRL extensions */ public ICMSCRLExtensions getCRLExtensions(); |