diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/publish/IPublishRuleSet.java')
| -rw-r--r-- | pki/base/common/src/com/netscape/certsrv/publish/IPublishRuleSet.java | 71 |
1 files changed, 37 insertions, 34 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/publish/IPublishRuleSet.java b/pki/base/common/src/com/netscape/certsrv/publish/IPublishRuleSet.java index e6cd3756e..6ff997a1d 100644 --- a/pki/base/common/src/com/netscape/certsrv/publish/IPublishRuleSet.java +++ b/pki/base/common/src/com/netscape/certsrv/publish/IPublishRuleSet.java @@ -17,6 +17,7 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.publish; + import java.util.Enumeration; import netscape.ldap.LDAPConnection; @@ -27,20 +28,22 @@ import com.netscape.certsrv.base.ISubsystem; import com.netscape.certsrv.ldap.ELdapException; import com.netscape.certsrv.request.IRequest; + /** * Represents a set of publishing rules. Publishing rules are ordered from - * lowest priority to highest priority. The priority assignment for publishing - * rules is not enforced by this interface. Various implementation may use - * different mechanisms such as a linear ordering of publishing rules in a - * configuration file or explicit assignment of priority levels ..etc. The - * publishing rule initialization needs to deal with reading the publishing - * rules, sorting them in increasing order of priority and presenting an ordered - * vector of publishing rules via the IPublishRuleSet interface. When a request - * comes, the predicates of the publishing rules will be checked in the order to - * find the first matched publishing rule as the mapping rule to (un)publish the - * object. + * lowest priority to highest priority. The priority assignment for publishing + * rules is not enforced by this interface. Various implementation may + * use different mechanisms such as a linear ordering of publishing rules + * in a configuration file or explicit assignment of priority levels ..etc. + * The publishing rule initialization needs to deal with reading the + * publishing rules, sorting them in increasing order of priority and + * presenting an ordered vector of publishing rules via the IPublishRuleSet + * interface. + * When a request comes, the predicates of the publishing rules will be + * checked in the order to find the first matched publishing rule as the + * mapping rule to (un)publish the object. * <P> - * + * * @version $Revision$, $Date$ */ public interface IPublishRuleSet { @@ -49,7 +52,7 @@ public interface IPublishRuleSet { /** * Returns the name of the publishing rule set. * <P> - * + * * @return The name of the publishing rule set. */ String getName(); @@ -57,7 +60,6 @@ public interface IPublishRuleSet { /** * Returns the no of publishing rules in a set. * <P> - * * @return the no of publishing rules. */ int count(); @@ -65,34 +67,33 @@ public interface IPublishRuleSet { /** * Add a publishing rule * <P> - * - * @param aliasName The name of the publishing rule to be added. - * @param rule rule The publishing rule to be added. + * + * @param aliasName The name of the publishing rule to be added. + * @param rule rule The publishing rule to be added. */ void addRule(String aliasName, ILdapRule rule); /** * Removes a publishing rule identified by the given name. - * - * @param ruleName The name of the publishing rule to be removed. + * + * @param ruleName The name of the publishing rule to be removed. */ void removeRule(String ruleName); /** * Get the publishing rule identified by a given name. * <P> - * - * @param ruleName The name of the publishing rule to be return. - * @return The publishing rule identified by the given name or null if none - * exists. + * + * @param ruleName The name of the publishing rule to be return. + * @return The publishing rule identified by the given name or null if none exists. */ ILdapRule getRule(String ruleName); /** * Get the publishing rule identified by a corresponding request. * <P> - * - * @param req The request from which rule will be identified. + * + * @param req The request from which rule will be identified. * @return The publishing rule or null if none exists. */ ILdapRule getRule(IRequest req); @@ -100,22 +101,24 @@ public interface IPublishRuleSet { /** * Get an enumeration of publishing rules. * <P> - * + * * @return An enumeration of publishing rules. */ Enumeration getRules(); /** - * Apply publishing rules on a request. The predicates of the publishing - * rules will be checked in the order to find the first matched publishing - * rule. Use the mapper to find the dn of the LDAP entry and use the - * publisher to publish the object in the request. + * Apply publishing rules on a request. + * The predicates of the publishing rules will be checked in the order + * to find the first matched publishing rule. + * Use the mapper to find the dn of the LDAP entry and use the publisher + * to publish the object in the request. * <P> - * - * @param conn The Ldap connection - * @param req The request to apply policies on. - * @exception ELdapException publish failed due to Ldap error. + * + * @param conn The Ldap connection + * @param req The request to apply policies on. + * @exception ELdapException publish failed due to Ldap error. */ public void publish(LDAPConnection conn, IRequest req) - throws ELdapException; + throws ELdapException; } + |