1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.publish;
import java.util.Enumeration;
import netscape.ldap.LDAPConnection;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IConfigStore;
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.
* <P>
*
* @version $Revision$, $Date$
*/
public interface IPublishRuleSet {
void init(ISubsystem sys, IConfigStore conf) throws EBaseException;
/**
* Returns the name of the publishing rule set.
* <P>
*
* @return The name of the publishing rule set.
*/
String getName();
/**
* Returns the no of publishing rules in a set.
* <P>
*
* @return the no of publishing rules.
*/
int count();
/**
* 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.
*/
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.
*/
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.
*/
ILdapRule getRule(String ruleName);
/**
* Get the publishing rule identified by a corresponding request.
* <P>
*
* @param req The request from which rule will be identified.
* @return The publishing rule or null if none exists.
*/
ILdapRule getRule(IRequest req);
/**
* Get an enumeration of publishing rules.
* <P>
*
* @return An enumeration of publishing rules.
*/
Enumeration<ILdapRule> 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.
* <P>
*
* @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;
}
|
