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   *    http://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.actions.compareRequest;
21  
22  
23  import org.apache.directory.api.asn1.DecoderException;
24  import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
25  import org.apache.directory.api.asn1.ber.tlv.TLV;
26  import org.apache.directory.api.i18n.I18n;
27  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
28  import org.apache.directory.api.ldap.codec.api.ResponseCarryingException;
29  import org.apache.directory.api.ldap.codec.decorators.CompareRequestDecorator;
30  import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
31  import org.apache.directory.api.ldap.model.message.CompareRequest;
32  import org.apache.directory.api.ldap.model.message.CompareResponseImpl;
33  import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
34  import org.apache.directory.api.ldap.model.name.Dn;
35  import org.apache.directory.api.util.Strings;
36  import org.slf4j.Logger;
37  import org.slf4j.LoggerFactory;
38  
39  
40  /**
41   * The action used to store the Compare Request name
42   * <pre>
43   * CompareRequest ::= [APPLICATION 14] SEQUENCE {
44   *     entry    LDAPDN,
45   *     ...
46   * </pre>
47   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
48   */
49  public class StoreCompareRequestEntryName extends GrammarAction<LdapMessageContainer<CompareRequestDecorator>>
50  {
51      /** The logger */
52      private static final Logger LOG = LoggerFactory.getLogger( StoreCompareRequestEntryName.class );
53  
54      /** Speedup for logs */
55      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
56  
57  
58      /**
59       * Instantiates a new action.
60       */
61      public StoreCompareRequestEntryName()
62      {
63          super( "Store CompareRequest entry Name" );
64      }
65  
66  
67      /**
68       * {@inheritDoc}
69       */
70      public void action( LdapMessageContainer<CompareRequestDecorator> container ) throws DecoderException
71      {
72          CompareRequest compareRequest = container.getMessage();
73  
74          // Get the Value and store it in the CompareRequest
75          TLV tlv = container.getCurrentTLV();
76          Dn entry = null;
77  
78          // We have to handle the special case of a 0 length matched
79          // Dn
80          if ( tlv.getLength() == 0 )
81          {
82              // This will generate a PROTOCOL_ERROR
83              throw new DecoderException( I18n.err( I18n.ERR_04089 ) );
84          }
85          else
86          {
87              byte[] dnBytes = tlv.getValue().getData();
88              String dnStr = Strings.utf8ToString( dnBytes );
89  
90              try
91              {
92                  entry = new Dn( dnStr );
93              }
94              catch ( LdapInvalidDnException ine )
95              {
96                  String msg = "Invalid Dn given : " + dnStr + " (" + Strings.dumpBytes( dnBytes )
97                      + ") is invalid";
98                  LOG.error( "{} : {}", msg, ine.getMessage() );
99  
100                 CompareResponseImpl response = new CompareResponseImpl( compareRequest.getMessageId() );
101                 throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX,
102                     Dn.EMPTY_DN, ine );
103             }
104 
105             compareRequest.setName( entry );
106         }
107 
108         if ( IS_DEBUG )
109         {
110             LOG.debug( "Comparing Dn {}", entry );
111         }
112     }
113 }