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 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.backends.jeb;
028    
029    import org.opends.server.types.DN;
030    
031    import java.util.ArrayList;
032    
033    /**
034     * This class represents the configuration of a JE backend verification process.
035     */
036    public class VerifyConfig
037    {
038      /**
039       * The base DN to be verified.
040       */
041      private DN baseDN;
042    
043      /**
044       * The names of indexes to be verified for completeness.
045       */
046      private ArrayList<String> completeList;
047    
048      /**
049       * The names of indexes to be verified for cleanliness.
050       */
051      private ArrayList<String> cleanList;
052    
053      /**
054       * Create a new verify configuration.
055       */
056      public VerifyConfig()
057      {
058        baseDN = null;
059        completeList = new ArrayList<String>();
060        cleanList = new ArrayList<String>();
061      }
062    
063      /**
064       * Get the base DN to be verified.
065       * @return The base DN to be verified.
066       */
067      public DN getBaseDN()
068      {
069        return baseDN;
070      }
071    
072      /**
073       * Set the base DN to be verified.
074       * @param baseDN The base DN to be verified.
075       */
076      public void setBaseDN(DN baseDN)
077      {
078        this.baseDN = baseDN;
079      }
080    
081      /**
082       * Get the names of indexes to be verified for completeness.
083       * @return The names of indexes to be verified for completeness.
084       */
085      public ArrayList<String> getCompleteList()
086      {
087        return completeList;
088      }
089    
090      /**
091       * Add the name of an index to those indexes to be verified for completeness.
092       * @param index The name of an index to be verified for completeness.
093       */
094      public void addCompleteIndex(String index)
095      {
096        completeList.add(index);
097      }
098    
099      /**
100       * Get the names of indexes to be verified for cleanliness.
101       * @return The names of indexes to be verified for cleanliness.
102       */
103      public ArrayList<String> getCleanList()
104      {
105        return cleanList;
106      }
107    
108      /**
109       * Add the name of an index to those indexes to be verified for cleanliness.
110       * @param index The name of an index to be verified for cleanliness.
111       */
112      public void addCleanIndex(String index)
113      {
114        cleanList.add(index);
115      }
116    }