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.server.ConfigurationChangeListener;
033    import org.opends.server.admin.std.meta.PluginCfgDefn.PluginType;
034    import org.opends.server.types.AttributeType;
035    import org.opends.server.types.DN;
036    
037    
038    
039    /**
040     * A server-side interface for querying Referential Integrity Plugin
041     * settings.
042     * <p>
043     * The Referential Integrity Plugin maintains referential integrity
044     * for DN valued attributes.
045     */
046    public interface ReferentialIntegrityPluginCfg extends PluginCfg {
047    
048      /**
049       * Gets the configuration class associated with this Referential Integrity Plugin.
050       *
051       * @return Returns the configuration class associated with this Referential Integrity Plugin.
052       */
053      Class<? extends ReferentialIntegrityPluginCfg> configurationClass();
054    
055    
056    
057      /**
058       * Register to be notified when this Referential Integrity Plugin is changed.
059       *
060       * @param listener
061       *          The Referential Integrity Plugin configuration change listener.
062       */
063      void addReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener);
064    
065    
066    
067      /**
068       * Deregister an existing Referential Integrity Plugin configuration change listener.
069       *
070       * @param listener
071       *          The Referential Integrity Plugin configuration change listener.
072       */
073      void removeReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener);
074    
075    
076    
077      /**
078       * Gets the "attribute-type" property.
079       * <p>
080       * Specifies the attribute types for which referential integrity is
081       * to be maintained.
082       * <p>
083       * At least one attribute type must be specified, and the syntax of
084       * any attributes must be either a distinguished name
085       * (1.3.6.1.4.1.1466.115.121.1.12) or name and optional UID
086       * (1.3.6.1.4.1.1466.115.121.1.34).
087       *
088       * @return Returns an unmodifiable set containing the values of the "attribute-type" property.
089       */
090      SortedSet<AttributeType> getAttributeType();
091    
092    
093    
094      /**
095       * Gets the "base-dn" property.
096       * <p>
097       * Specifies the base DN that limits the scope within which
098       * referential integrity is maintained.
099       *
100       * @return Returns an unmodifiable set containing the values of the "base-dn" property.
101       */
102      SortedSet<DN> getBaseDN();
103    
104    
105    
106      /**
107       * Gets the "java-class" property.
108       * <p>
109       * Specifies the fully-qualified name of the Java class that
110       * provides the plug-in implementation.
111       *
112       * @return Returns the value of the "java-class" property.
113       */
114      String getJavaClass();
115    
116    
117    
118      /**
119       * Gets the "log-file" property.
120       * <p>
121       * Specifies the log file location where the update records are
122       * written when the plug-in is in background-mode processing.
123       * <p>
124       * The default location is the logs directory of the server
125       * instance, using the file name "referint".
126       *
127       * @return Returns the value of the "log-file" property.
128       */
129      String getLogFile();
130    
131    
132    
133      /**
134       * Gets the "plugin-type" property.
135       * <p>
136       * Specifies the set of plug-in types for the plug-in, which
137       * specifies the times at which the plug-in is invoked.
138       *
139       * @return Returns an unmodifiable set containing the values of the "plugin-type" property.
140       */
141      SortedSet<PluginType> getPluginType();
142    
143    
144    
145      /**
146       * Gets the "update-interval" property.
147       * <p>
148       * Specifies the interval in seconds when referential integrity
149       * updates are made.
150       * <p>
151       * If this value is 0, then the updates are made synchronously in
152       * the foreground.
153       *
154       * @return Returns the value of the "update-interval" property.
155       */
156      long getUpdateInterval();
157    
158    }