View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    https://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.directory.api.ldap.codec.factory;
21  
22  import org.apache.directory.api.asn1.ber.tlv.BerValue;
23  import org.apache.directory.api.asn1.util.Asn1Buffer;
24  import org.apache.directory.api.ldap.codec.api.LdapApiService;
25  import org.apache.directory.api.ldap.codec.api.LdapCodecConstants;
26  import org.apache.directory.api.ldap.model.message.CompareRequest;
27  import org.apache.directory.api.ldap.model.message.Message;
28  
29  /**
30   * The CompareRequest factory.
31   *
32   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33   */
34  public final class CompareRequestFactory implements Messagefactory
35  {
36      /** The static instance */
37      public static final CompareRequestFactory INSTANCE = new CompareRequestFactory();
38  
39      private CompareRequestFactory()
40      {
41          // Nothing to do
42      }
43  
44      /**
45       * Encode the CompareRequest message to a PDU.
46       * <br>
47       * <pre>
48       * CompareRequest :
49       *   0x6E LL
50       *     0x04 LL entry
51       *     0x30 LL attributeValueAssertion
52       *       0x04 LL attributeDesc
53       *       0x04 LL assertionValue
54       * </pre>
55       *
56       * @param codec The LdapApiService instance
57       * @param buffer The buffer where to put the PDU
58       * @param message the CompareRequest to encode
59       */
60      @Override
61      public void encodeReverse( LdapApiService codec, Asn1Buffer buffer, Message message )
62      {
63          int pos = buffer.getPos();
64          CompareRequest compareMessage = ( CompareRequest ) message;
65  
66          // The assertionValue
67          BerValue.encodeOctetString( buffer, compareMessage.getAssertionValue().getBytes() );
68  
69          // The attributeDesc
70          BerValue.encodeOctetString( buffer, compareMessage.getAttributeId() );
71  
72          // The attributeValueAssertion sequence Tag
73          BerValue.encodeSequence( buffer, pos );
74  
75          // The entry DN
76          BerValue.encodeOctetString( buffer, compareMessage.getName().getName() );
77  
78          // The CompareRequest Tag
79          BerValue.encodeSequence( buffer, LdapCodecConstants.COMPARE_REQUEST_TAG, pos );
80      }
81  }