Formatting (no line wrap in comments or code)

1 files changed, 77 insertions, 53 deletions

diff --git a/pki/base/common/src/com/netscape/certsrv/publish/IPublisherProcessor.java b/pki/base/common/src/com/netscape/certsrv/publish/IPublisherProcessor.java
index 1da2f3467..3ed985403 100644
--- a/pki/base/common/src/com/netscape/certsrv/publish/IPublisherProcessor.java
+++ b/pki/base/common/src/com/netscape/certsrv/publish/IPublisherProcessor.java
@@ -17,7 +17,6 @@
 // --- END COPYRIGHT BLOCK ---
 package com.netscape.certsrv.publish;
 
-
 import java.math.BigInteger;
 import java.security.cert.X509CRL;
 import java.security.cert.X509Certificate;
@@ -32,11 +31,10 @@ import com.netscape.certsrv.ldap.ELdapException;
 import com.netscape.certsrv.ldap.ILdapConnModule;
 import com.netscape.certsrv.request.IRequest;
 
-
 /**
- *  Controls the publishing process from the top level.  Maintains
- *  a collection of Publishers , Mappers, and Publish Rules.
- *
+ * Controls the publishing process from the top level. Maintains
+ * a collection of Publishers , Mappers, and Publish Rules.
+ * 
  * @version $Revision$ $Date$
  */
 
@@ -64,63 +62,66 @@ public interface IPublisherProcessor extends ISubsystem {
     public static final String PROP_TYPE = "type";
 
     /**
-     *
+     * 
      * Returns Hashtable of rule plugins.
      */
 
     public Hashtable<String, RulePlugin> getRulePlugins();
 
     /**
-     *
-     * Returns Hashtable of rule  instances.
+     * 
+     * Returns Hashtable of rule instances.
      */
 
     public Hashtable<String, ILdapRule> getRuleInsts();
 
     /**
-     *
+     * 
      * Returns Hashtable of mapper plugins.
      */
 
     public Hashtable<String, MapperPlugin> getMapperPlugins();
 
     /**
-     *
+     * 
      * Returns Hashtable of publisher plugins.
      */
     public Hashtable<String, PublisherPlugin> getPublisherPlugins();
 
     /**
-     *
+     * 
      * Returns Hashtable of rule mapper instances.
      */
     public Hashtable<String, MapperProxy> getMapperInsts();
 
     /**
-     *
+     * 
      * Returns Hashtable of rule publisher instances.
      */
     public Hashtable<String, PublisherProxy> getPublisherInsts();
 
     /**
-     *
+     * 
      * Returns list of rules based on publishing type.
+     * 
      * @param publishingType Type for which to retrieve rule list.
      */
 
     public Enumeration<ILdapRule> getRules(String publishingType);
 
     /**
-     *
+     * 
      * Returns list of rules based on publishing type and publishing request.
+     * 
      * @param publishingType Type for which to retrieve rule list.
-     * @param req  Corresponding publish request.
+     * @param req Corresponding publish request.
      */
     public Enumeration<ILdapRule> getRules(String publishingType, IRequest req);
 
     /**
-     *
+     * 
      * Returns mapper initial default parameters.
+     * 
      * @param implName name of MapperPlugin.
      */
 
@@ -128,8 +129,9 @@ public interface IPublisherProcessor extends ISubsystem {
             ELdapException;
 
     /**
-     *
-     * Returns mapper current instance  parameters.
+     * 
+     * Returns mapper current instance parameters.
+     * 
      * @param insName name of MapperProxy.
      * @exception ELdapException failed due to Ldap error.
      */
@@ -138,8 +140,9 @@ public interface IPublisherProcessor extends ISubsystem {
             ELdapException;
 
     /**
-     *
+     * 
      * Returns publisher initial default parameters.
+     * 
      * @param implName name of PublisherPlugin.
      * @exception ELdapException failed due to Ldap error.
      */
@@ -147,8 +150,9 @@ public interface IPublisherProcessor extends ISubsystem {
             ELdapException;
 
     /**
-     *
+     * 
      * Returns true if MapperInstance is enabled.
+     * 
      * @param insName name of MapperProxy.
      * @return true if enabled. false if disabled.
      */
@@ -156,48 +160,54 @@ public interface IPublisherProcessor extends ISubsystem {
     public boolean isMapperInstanceEnable(String insName);
 
     /**
-     *
+     * 
      * Returns ILdapMapper instance that is currently active.
+     * 
      * @param insName name of MapperProxy.
      * @return instance of ILdapMapper.
-     */ 
+     */
     public ILdapMapper getActiveMapperInstance(String insName);
 
     /**
-     *
+     * 
      * Returns ILdapMapper instance based on name of MapperProxy.
+     * 
      * @param insName name of MapperProxy.
      * @return instance of ILdapMapper.
      */
     public ILdapMapper getMapperInstance(String insName);
 
     /**
-     *
+     * 
      * Returns true publisher instance is currently enabled.
+     * 
      * @param insName name of PublisherProxy.
      * @return true if enabled.
      */
     public boolean isPublisherInstanceEnable(String insName);
 
     /**
-     *
+     * 
      * Returns ILdapPublisher instance that is currently active.
+     * 
      * @param insName name of PublisherProxy.
      * @return instance of ILdapPublisher.
      */
     public ILdapPublisher getActivePublisherInstance(String insName);
 
     /**
-     *
+     * 
      * Returns ILdapPublisher instance.
+     * 
      * @param insName name of PublisherProxy.
      * @return instance of ILdapPublisher.
      */
     public ILdapPublisher getPublisherInstance(String insName);
 
     /**
-     *
+     * 
      * Returns Vector of PublisherIntance's current instance parameters.
+     * 
      * @param insName name of PublisherProxy.
      * @return Vector of current instance parameters.
      */
@@ -205,8 +215,9 @@ public interface IPublisherProcessor extends ISubsystem {
             ELdapException;
 
     /**
-     *
+     * 
      * Returns Vector of RulePlugin's initial default parameters.
+     * 
      * @param implName name of RulePlugin.
      * @return Vector of initial default parameters.
      * @exception ELdapException failed due to Ldap error.
@@ -215,8 +226,9 @@ public interface IPublisherProcessor extends ISubsystem {
             ELdapException;
 
     /**
-     *
+     * 
      * Returns Vector of RulePlugin's current instance parameters.
+     * 
      * @param implName name of RulePlugin.
      * @return Vector of current instance parameters.
      * @exception ELdapException failed due to Ldap error.
@@ -225,8 +237,9 @@ public interface IPublisherProcessor extends ISubsystem {
             ELdapException;
 
     /**
-     * Set published flag - true when published, false when unpublished. 
-     * Not exist means not published. 
+     * Set published flag - true when published, false when unpublished.
+     * Not exist means not published.
+     * 
      * @param serialNo serial number of publishable object.
      * @param published true for published, false for not.
      */
@@ -234,102 +247,113 @@ public interface IPublisherProcessor extends ISubsystem {
 
     /**
      * Publish ca cert, UpdateDir.java, jobs, request listeners
+     * 
      * @param cert X509 certificate to be published.
      * @exception ELdapException publish failed due to Ldap error.
      */
     public void publishCACert(X509Certificate cert)
-        throws ELdapException;
+            throws ELdapException;
 
     /**
      * This function is never called. CMS does not unpublish
      * CA certificate.
      */
     public void unpublishCACert(X509Certificate cert)
-        throws ELdapException;
+            throws ELdapException;
 
     /**
      * Publishs regular user certificate based on the criteria
      * set in the request.
+     * 
      * @param cert X509 certificate to be published.
-     * @param req  request which provides the criteria
+     * @param req request which provides the criteria
      * @exception ELdapException publish failed due to Ldap error.
      */
     public void publishCert(X509Certificate cert, IRequest req)
-        throws ELdapException;
+            throws ELdapException;
 
     /**
-     * Unpublish user certificate. This is used by 
+     * Unpublish user certificate. This is used by
      * UnpublishExpiredJob.
+     * 
      * @param cert X509 certificate to be unpublished.
-     * @param req  request which provides the criteria
+     * @param req request which provides the criteria
      * @exception ELdapException unpublish failed due to Ldap error.
      */
     public void unpublishCert(X509Certificate cert, IRequest req)
-        throws ELdapException;
+            throws ELdapException;
 
     /**
      * publishes a crl by mapping the issuer name in the crl to an entry
      * and publishing it there. entry must be a certificate authority.
      * Note that this is used by cmsgateway/cert/UpdateDir.java
+     * 
      * @param crl Certificate Revocation List
      * @param crlIssuingPointId name of the issuing point.
-    * @exception ELdapException publish failed due to Ldap error.
+     * @exception ELdapException publish failed due to Ldap error.
      */
-    public void publishCRL(X509CRLImpl crl,String crlIssuingPointId) 
-        throws ELdapException;
+    public void publishCRL(X509CRLImpl crl, String crlIssuingPointId)
+            throws ELdapException;
 
     /**
      * publishes a crl by mapping the issuer name in the crl to an entry
      * and publishing it there. entry must be a certificate authority.
-     * @param dn  Distinguished name to publish.
+     * 
+     * @param dn Distinguished name to publish.
      * @param crl Certificate Revocation List
      * @exception ELdapException publish failed due to Ldap error.
      */
-    public void publishCRL(String dn, X509CRL crl) 
-        throws ELdapException;
+    public void publishCRL(String dn, X509CRL crl)
+            throws ELdapException;
 
     /**
-     *
+     * 
      * Return true if Ldap is enabled.
+     * 
      * @return true if Ldap is enabled,otherwise false.
      */
 
     public boolean ldapEnabled();
 
     /**
-     *
+     * 
      * Return true of PublisherProcessor is enabled.
+     * 
      * @return true if is enabled, otherwise false.
-     *
+     * 
      */
     public boolean enabled();
 
     /**
-     *
-     *  Return Authority for which this Processor operates.
+     * 
+     * Return Authority for which this Processor operates.
+     * 
      * @return Authority.
      */
 
     public ISubsystem getAuthority();
 
     /**
-     *
+     * 
      * Perform logging function for this Processor.
-     * @param level  Log level to be used for this message
-     * @param msg    Message to be logged.
+     * 
+     * @param level Log level to be used for this message
+     * @param msg Message to be logged.
      */
 
     public void log(int level, String msg);
 
     /**
-     *
+     * 
      * Returns LdapConnModule belonging to this Processor.
+     * 
      * @return LdapConnModule.
      */
     public ILdapConnModule getLdapConnModule();
 
     /**
      * Sets the LdapConnModule belonging to this Processor.
+     * 
      * @param m ILdapConnModule.
      */
     public void setLdapConnModule(ILdapConnModule m);