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.schema;
028    
029    
030    
031    import java.util.Arrays;
032    
033    import org.opends.server.admin.std.server.EqualityMatchingRuleCfg;
034    import org.opends.server.api.EqualityMatchingRule;
035    import org.opends.server.config.ConfigException;
036    import org.opends.server.protocols.asn1.ASN1OctetString;
037    import org.opends.server.types.ByteString;
038    import org.opends.server.types.DirectoryException;
039    import org.opends.server.types.InitializationException;
040    
041    import static org.opends.server.schema.SchemaConstants.*;
042    
043    
044    
045    /**
046     * This class defines the caseExactMatch matching rule defined in X.520 and
047     * referenced in RFC 4519.
048     */
049    public class CaseExactEqualityMatchingRule
050           extends EqualityMatchingRule
051    {
052      /**
053       * Creates a new instance of this caseExactMatch matching rule.
054       */
055      public CaseExactEqualityMatchingRule()
056      {
057        super();
058      }
059    
060    
061    
062      /**
063       * {@inheritDoc}
064       */
065      public void initializeMatchingRule(EqualityMatchingRuleCfg configuration)
066             throws ConfigException, InitializationException
067      {
068        // No initialization is required.
069      }
070    
071    
072    
073      /**
074       * Retrieves the common name for this matching rule.
075       *
076       * @return  The common name for this matching rule, or <CODE>null</CODE> if
077       * it does not have a name.
078       */
079      public String getName()
080      {
081        return EMR_CASE_EXACT_NAME;
082      }
083    
084    
085    
086      /**
087       * Retrieves the OID for this matching rule.
088       *
089       * @return  The OID for this matching rule.
090       */
091      public String getOID()
092      {
093        return EMR_CASE_EXACT_OID;
094      }
095    
096    
097    
098      /**
099       * Retrieves the description for this matching rule.
100       *
101       * @return  The description for this matching rule, or <CODE>null</CODE> if
102       *          there is none.
103       */
104      public String getDescription()
105      {
106        // There is no standard description for this matching rule.
107        return null;
108      }
109    
110    
111    
112      /**
113       * Retrieves the OID of the syntax with which this matching rule is
114       * associated.
115       *
116       * @return  The OID of the syntax with which this matching rule is associated.
117       */
118      public String getSyntaxOID()
119      {
120        return SYNTAX_DIRECTORY_STRING_OID;
121      }
122    
123    
124    
125      /**
126       * Retrieves the normalized form of the provided value, which is best suited
127       * for efficiently performing matching operations on that value.
128       *
129       * @param  value  The value to be normalized.
130       *
131       * @return  The normalized version of the provided value.
132       *
133       * @throws  DirectoryException  If the provided value is invalid according to
134       *                              the associated attribute syntax.
135       */
136      public ByteString normalizeValue(ByteString value)
137             throws DirectoryException
138      {
139        StringBuilder buffer = new StringBuilder();
140        buffer.append(value.stringValue().trim());
141    
142        int bufferLength = buffer.length();
143        if (bufferLength == 0)
144        {
145          if (value.value().length > 0)
146          {
147            // This should only happen if the value is composed entirely of spaces.
148            // In that case, the normalized value is a single space.
149            return new ASN1OctetString(" ");
150          }
151          else
152          {
153            // The value is empty, so it is already normalized.
154            return new ASN1OctetString();
155          }
156        }
157    
158    
159        // Replace any consecutive spaces with a single space.
160        for (int pos = bufferLength-1; pos > 0; pos--)
161        {
162          if (buffer.charAt(pos) == ' ')
163          {
164            if (buffer.charAt(pos-1) == ' ')
165            {
166              buffer.delete(pos, pos+1);
167            }
168          }
169        }
170    
171        return new ASN1OctetString(buffer.toString());
172      }
173    
174    
175    
176      /**
177       * Indicates whether the two provided normalized values are equal to each
178       * other.
179       *
180       * @param  value1  The normalized form of the first value to compare.
181       * @param  value2  The normalized form of the second value to compare.
182       *
183       * @return  <CODE>true</CODE> if the provided values are equal, or
184       *          <CODE>false</CODE> if not.
185       */
186      public boolean areEqual(ByteString value1, ByteString value2)
187      {
188        // Since the values are already normalized, we just need to compare the
189        // associated byte arrays.
190        return Arrays.equals(value1.value(), value2.value());
191      }
192    }
193