1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.server.replication.configuration;
21
22
23 import java.util.List;
24 import java.util.Set;
25
26 import org.apache.directory.shared.ldap.name.LdapDN;
27 import org.apache.directory.shared.ldap.subtree.SubtreeSpecification;
28
29
30 /**
31 * Document me!
32 *
33 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34 * @version $Rev$
35 */
36 public class ReplicationAgreement
37 {
38 /**
39 * Each replication agreement has a unique identifier.
40 */
41 String id;
42
43 /**
44 * The set of critical attributes: those that trigger the immediate
45 * initiation of a replication cycle.
46 *
47 * These are numeric attribute OIDs so the structure can be used for
48 * fast lookups.
49 */
50 Set<String> criticalAttributes;
51
52 /**
53 * The set of attributes that are not replicated: note that attributes
54 * of type dSAOperation and collective attributes are not replicated.
55 *
56 * These are numeric attribute OIDs so the structure can be used for
57 * fast lookups.
58 */
59 Set<String> exclusions;
60
61 /**
62 * The set of attributes that are replicated. Some attributes may be
63 * dSAOperation attributes and may still need to be replicated.
64 *
65 * These are numeric attribute OIDs so the structure can be used for
66 * fast lookups.
67 */
68 Set<String> inclusions;
69
70 /**
71 * The replication group (list of replicas) composing this agreement.
72 */
73 List<Replica> replicationGroup;
74
75 /**
76 * The replicatin area defined as a subtreeSpecification.
77 */
78 SubtreeSpecification area;
79
80 /**
81 * The administrative point for the replication specific autonomous area.
82 */
83 LdapDN replicationBase;
84
85 /**
86 * The schedule to use for initiating replication cycles. You can have more than
87 * one trigger assigned to initiate replication. This may be:
88 * <ul>
89 * <li>periodic</li>
90 * <li>manual</li>
91 * <li>singular</li>
92 * <li>on change with optional delay</li>
93 * <li>after meeting a threshold of changes</li>
94 * <li>minimum time after the last replication cycle</li>
95 * </ul>
96 */
97 Set<ReplicationTrigger> replicationSchedule;
98
99 /**
100 * Who to notify, why and how.
101 */
102 NotificationScheme notificationScheme;
103 }