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 octetStringMatch matching rule defined in X.520.  It
047     * will be used as the default equality matching rule for the binary and octet
048     * string syntaxes.
049     */
050    public class OctetStringEqualityMatchingRule
051           extends EqualityMatchingRule
052    {
053      /**
054       * Creates a new instance of this caseExactMatch matching rule.
055       */
056      public OctetStringEqualityMatchingRule()
057      {
058        super();
059      }
060    
061    
062    
063      /**
064       * {@inheritDoc}
065       */
066      public void initializeMatchingRule(EqualityMatchingRuleCfg configuration)
067             throws ConfigException, InitializationException
068      {
069        // No initialization is required.
070      }
071    
072    
073    
074      /**
075       * Retrieves the common name for this matching rule.
076       *
077       * @return  The common name for this matching rule, or <CODE>null</CODE> if
078       * it does not have a name.
079       */
080      public String getName()
081      {
082        return EMR_OCTET_STRING_NAME;
083      }
084    
085    
086    
087      /**
088       * Retrieves the OID for this matching rule.
089       *
090       * @return  The OID for this matching rule.
091       */
092      public String getOID()
093      {
094        return EMR_OCTET_STRING_OID;
095      }
096    
097    
098    
099      /**
100       * Retrieves the description for this matching rule.
101       *
102       * @return  The description for this matching rule, or <CODE>null</CODE> if
103       *          there is none.
104       */
105      public String getDescription()
106      {
107        // There is no standard description for this matching rule.
108        return null;
109      }
110    
111    
112    
113      /**
114       * Retrieves the OID of the syntax with which this matching rule is
115       * associated.
116       *
117       * @return  The OID of the syntax with which this matching rule is associated.
118       */
119      public String getSyntaxOID()
120      {
121        return SYNTAX_OCTET_STRING_OID;
122      }
123    
124    
125    
126      /**
127       * Retrieves the normalized form of the provided value, which is best suited
128       * for efficiently performing matching operations on that value.
129       *
130       * @param  value  The value to be normalized.
131       *
132       * @return  The normalized version of the provided value.
133       *
134       * @throws  DirectoryException  If the provided value is invalid according to
135       *                              the associated attribute syntax.
136       */
137      public ByteString normalizeValue(ByteString value)
138             throws DirectoryException
139      {
140        return new ASN1OctetString(value.value());
141      }
142    
143    
144    
145      /**
146       * Indicates whether the two provided normalized values are equal to each
147       * other.
148       *
149       * @param  value1  The normalized form of the first value to compare.
150       * @param  value2  The normalized form of the second value to compare.
151       *
152       * @return  <CODE>true</CODE> if the provided values are equal, or
153       *          <CODE>false</CODE> if not.
154       */
155      public boolean areEqual(ByteString value1, ByteString value2)
156      {
157        // Since the values are already normalized, we just need to compare the
158        // associated byte arrays.
159        return Arrays.equals(value1.value(), value2.value());
160      }
161    }
162