001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020 package org.apache.directory.server.replication.configuration; 021 022 023 import java.util.List; 024 import java.util.Set; 025 026 import org.apache.directory.shared.ldap.name.DN; 027 import org.apache.directory.shared.ldap.subtree.SubtreeSpecification; 028 029 030 /** 031 * Document me! 032 * 033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 034 * @version $Rev$ 035 */ 036 public class ReplicationAgreement 037 { 038 /** 039 * Each replication agreement has a unique identifier. 040 */ 041 String id; 042 043 /** 044 * The set of critical attributes: those that trigger the immediate 045 * initiation of a replication cycle. 046 * 047 * These are numeric attribute OIDs so the structure can be used for 048 * fast lookups. 049 */ 050 Set<String> criticalAttributes; 051 052 /** 053 * The set of attributes that are not replicated: note that attributes 054 * of type dSAOperation and collective attributes are not replicated. 055 * 056 * These are numeric attribute OIDs so the structure can be used for 057 * fast lookups. 058 */ 059 Set<String> exclusions; 060 061 /** 062 * The set of attributes that are replicated. Some attributes may be 063 * dSAOperation attributes and may still need to be replicated. 064 * 065 * These are numeric attribute OIDs so the structure can be used for 066 * fast lookups. 067 */ 068 Set<String> inclusions; 069 070 /** 071 * The replication group (list of replicas) composing this agreement. 072 */ 073 List<Replica> replicationGroup; 074 075 /** 076 * The replicatin area defined as a subtreeSpecification. 077 */ 078 SubtreeSpecification area; 079 080 /** 081 * The administrative point for the replication specific autonomous area. 082 */ 083 DN replicationBase; 084 085 /** 086 * The schedule to use for initiating replication cycles. You can have more than 087 * one trigger assigned to initiate replication. This may be: 088 * <ul> 089 * <li>periodic</li> 090 * <li>manual</li> 091 * <li>singular</li> 092 * <li>on change with optional delay</li> 093 * <li>after meeting a threshold of changes</li> 094 * <li>minimum time after the last replication cycle</li> 095 * </ul> 096 */ 097 Set<ReplicationTrigger> replicationSchedule; 098 099 /** 100 * Who to notify, why and how. 101 */ 102 NotificationScheme notificationScheme; 103 }