diff options
author | Ade Lee <alee@redhat.com> | 2011-12-07 16:58:12 -0500 |
---|---|---|
committer | Ade Lee <alee@redhat.com> | 2011-12-07 16:58:12 -0500 |
commit | 32150d3ee32f8ac27118af7c792794b538c78a2f (patch) | |
tree | 52dd96f664a6fa51be25b28b6f10adc5f2c9f660 /pki/base/common/src/com/netscape/certsrv/publish/ICRLPublisher.java | |
parent | f05d58a46795553beb8881039cc922974b40db34 (diff) | |
download | pki-32150d3ee32f8ac27118af7c792794b538c78a2f.tar.gz pki-32150d3ee32f8ac27118af7c792794b538c78a2f.tar.xz pki-32150d3ee32f8ac27118af7c792794b538c78a2f.zip |
Formatting
Formatted project according to eclipse project settings
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/publish/ICRLPublisher.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/publish/ICRLPublisher.java | 86 |
1 files changed, 38 insertions, 48 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/publish/ICRLPublisher.java b/pki/base/common/src/com/netscape/certsrv/publish/ICRLPublisher.java index cae75d2f8..e426d9317 100644 --- a/pki/base/common/src/com/netscape/certsrv/publish/ICRLPublisher.java +++ b/pki/base/common/src/com/netscape/certsrv/publish/ICRLPublisher.java @@ -17,50 +17,43 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.publish; - import netscape.security.x509.X509CRLImpl; import com.netscape.certsrv.base.EBaseException; import com.netscape.certsrv.base.IConfigStore; import com.netscape.certsrv.base.ISubsystem; - /** - * This interface represents a CRL publisher that is - * invoked when CRL publishing is requested by CMS. - * Note that CMS, by default, shipped with a LDAP-based - * CRL publisher that can be configured via - * Certificiate Manager/LDAP Publishing panel. This - * interface provides administrator additional capability - * of publishing CRL to different destinations. - * - * The CRL publishing frequency is configured via - * Netscape Certificate Server Console's - * Certificate Manager/Revocation List panel. - * The CRL publishing may occur either everytime a - * certificate is revoked or at a pre-defined interval. + * This interface represents a CRL publisher that is invoked when CRL publishing + * is requested by CMS. Note that CMS, by default, shipped with a LDAP-based CRL + * publisher that can be configured via Certificiate Manager/LDAP Publishing + * panel. This interface provides administrator additional capability of + * publishing CRL to different destinations. * - * To try out this new CRL publisher mechanism, do - * the following: - * (1) Write a sample CRL publisher class that implements - * ICRLPublisher interface. For example, + * The CRL publishing frequency is configured via Netscape Certificate Server + * Console's Certificate Manager/Revocation List panel. The CRL publishing may + * occur either everytime a certificate is revoked or at a pre-defined interval. + * + * To try out this new CRL publisher mechanism, do the following: (1) Write a + * sample CRL publisher class that implements ICRLPublisher interface. For + * example, * * <code> * public class CRLPublisher implements ICRLPublisher * { * public void init(ISubsystem owner, IConfigStore config) - * throws EBaseException + * throws EBaseException * { - * log(ILogger.LL_DEBUG, "CRLPublisher: Initialized"); + * log(ILogger.LL_DEBUG, "CRLPublisher: Initialized"); * } - * - * public void publish(String issuingPointId, X509CRLImpl crl) + * + * public void publish(String issuingPointId, X509CRLImpl crl) * throws EBaseException * { * log(ILogger.LL_DEBUG, "CRLPublisher: " + issuingPointId + * " crl=" + crl); * } - * + * * public void log(int level, String msg) * { * Logger.getLogger().log(ILogger.EV_SYSTEM, @@ -69,14 +62,12 @@ import com.netscape.certsrv.base.ISubsystem; * } * } * </code> - * - * (2) Compile the class and place the class into - * <server-root>\bin\cert\classes directory. - * (3) Add the following parameter to CMS.cfg - * ca.crlPublisher.class=<implementation class> - * For example, - * ca.crlPublisher.class=myCRLPublisher - * + * + * (2) Compile the class and place the class into <server-root>\bin\cert\classes + * directory. (3) Add the following parameter to CMS.cfg + * ca.crlPublisher.class=<implementation class> For example, + * ca.crlPublisher.class=myCRLPublisher + * * @version $Revision$, $Date$ */ public interface ICRLPublisher { @@ -84,26 +75,25 @@ public interface ICRLPublisher { /** * Initializes this CRL publisher. * - * @param owner parent of the publisher. An object of type - * CertificateAuthority. - * @param config config store for this publisher. If this - * publisher requires configuration parameters for - * initialization, the parameters should be placed - * in CMS.cfg as ca.crlPublisher.<paramType>=<paramValue> + * @param owner parent of the publisher. An object of type + * CertificateAuthority. + * @param config config store for this publisher. If this publisher requires + * configuration parameters for initialization, the parameters + * should be placed in CMS.cfg as + * ca.crlPublisher.<paramType>=<paramValue> * @exception EBaseException failed to initialize this publisher */ - public void init(ISubsystem owner, IConfigStore config) - throws EBaseException; + public void init(ISubsystem owner, IConfigStore config) + throws EBaseException; /** - * Publishes CRL. This method is invoked by CMS based - * on the configured CRL publishing frequency. - * - * @param issuingPointId CRL issuing point identifier - * (i.e. MasterCRL) + * Publishes CRL. This method is invoked by CMS based on the configured CRL + * publishing frequency. + * + * @param issuingPointId CRL issuing point identifier (i.e. MasterCRL) * @param crl CRL that is publishing * @exception EBaseException failed to publish */ - public void publish(String issuingPointId, X509CRLImpl crl) - throws EBaseException; -} + public void publish(String issuingPointId, X509CRLImpl crl) + throws EBaseException; +} |