001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.server;
028    
029    
030    
031    import java.util.SortedSet;
032    import org.opends.server.admin.Configuration;
033    import org.opends.server.admin.server.ConfigurationChangeListener;
034    import org.opends.server.admin.std.meta.ReplicationDomainCfgDefn.IsolationPolicy;
035    import org.opends.server.types.DN;
036    
037    
038    
039    /**
040     * A server-side interface for querying Replication Domain settings.
041     * <p>
042     * A Replication Domain comprises of several Directory Servers sharing
043     * the same synchronized set of data.
044     */
045    public interface ReplicationDomainCfg extends Configuration {
046    
047      /**
048       * Gets the configuration class associated with this Replication Domain.
049       *
050       * @return Returns the configuration class associated with this Replication Domain.
051       */
052      Class<? extends ReplicationDomainCfg> configurationClass();
053    
054    
055    
056      /**
057       * Register to be notified when this Replication Domain is changed.
058       *
059       * @param listener
060       *          The Replication Domain configuration change listener.
061       */
062      void addChangeListener(ConfigurationChangeListener<ReplicationDomainCfg> listener);
063    
064    
065    
066      /**
067       * Deregister an existing Replication Domain configuration change listener.
068       *
069       * @param listener
070       *          The Replication Domain configuration change listener.
071       */
072      void removeChangeListener(ConfigurationChangeListener<ReplicationDomainCfg> listener);
073    
074    
075    
076      /**
077       * Gets the "base-dn" property.
078       * <p>
079       * Specifies the base DN of the replicated data.
080       *
081       * @return Returns the value of the "base-dn" property.
082       */
083      DN getBaseDN();
084    
085    
086    
087      /**
088       * Gets the "heartbeat-interval" property.
089       * <p>
090       * Specifies the heart-beat interval that the Directory Server will
091       * use when communicating with Replication Servers.
092       * <p>
093       * The Directory Server expects a regular heart-beat coming from the
094       * Replication Server within the specified interval. If a heartbeat
095       * is not received within the interval, the Directory Server closes
096       * its connection and connects to another Replication Server.
097       *
098       * @return Returns the value of the "heartbeat-interval" property.
099       */
100      long getHeartbeatInterval();
101    
102    
103    
104      /**
105       * Gets the "isolation-policy" property.
106       * <p>
107       * Specifies the behavior of the Directory Server if a write
108       * operation is attempted on the data within the Replication Domain
109       * when none of the configured Replication Servers are available.
110       *
111       * @return Returns the value of the "isolation-policy" property.
112       */
113      IsolationPolicy getIsolationPolicy();
114    
115    
116    
117      /**
118       * Gets the "replication-server" property.
119       * <p>
120       * Specifies the addresses of the Replication Servers within the
121       * Replication Domain to which the Directory Server should try to
122       * connect at startup time.
123       * <p>
124       * Addresses must be specified using the syntax: hostname:port
125       *
126       * @return Returns an unmodifiable set containing the values of the "replication-server" property.
127       */
128      SortedSet<String> getReplicationServer();
129    
130    
131    
132      /**
133       * Gets the "server-id" property.
134       * <p>
135       * Specifies a unique identifier for the Directory Server within the
136       * Replication Domain.
137       * <p>
138       * Each Directory Server within the same Replication Domain must
139       * have a different server ID. A Directory Server which is a member
140       * of multiple Replication Domains may use the same server ID for
141       * each of its Replication Domain configurations.
142       *
143       * @return Returns the value of the "server-id" property.
144       */
145      int getServerId();
146    
147    
148    
149      /**
150       * Gets the "window-size" property.
151       * <p>
152       * Specifies the window size that the Directory Server will use when
153       * communicating with Replication Servers.
154       *
155       * @return Returns the value of the "window-size" property.
156       */
157      int getWindowSize();
158    
159    }