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.controls;
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.asn1.util.Oid;
27  import org.apache.directory.api.i18n.I18n;
28  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
29  import org.apache.directory.api.ldap.codec.api.MessageDecorator;
30  import org.apache.directory.api.ldap.model.message.Control;
31  import org.apache.directory.api.ldap.model.message.Message;
32  import org.apache.directory.api.util.Strings;
33  import org.slf4j.Logger;
34  import org.slf4j.LoggerFactory;
35  
36  
37  /**
38   * The action used add a new control. We store its OID.
39   * <pre>
40   * Control ::= SEQUENCE {
41   *     controlType             LDAPOID,
42   *     ...
43   * </pre>
44   *
45   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
46   */
47  public class AddControl extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
48  {
49      /** The logger */
50      private static final Logger LOG = LoggerFactory.getLogger( AddControl.class );
51  
52      /** Speedup for logs */
53      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
54  
55  
56      /**
57       * Instantiates a new AddControl action.
58       */
59      public AddControl()
60      {
61          super( "Add a new control" );
62      }
63  
64  
65      /**
66       * {@inheritDoc}
67       */
68      public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
69      {
70          TLV tlv = container.getCurrentTLV();
71  
72          // Store the type
73          // We have to handle the special case of a 0 length OID
74          if ( tlv.getLength() == 0 )
75          {
76              String msg = I18n.err( I18n.ERR_04097 );
77              LOG.error( msg );
78  
79              // This will generate a PROTOCOL_ERROR
80              throw new DecoderException( msg );
81          }
82  
83          byte[] value = tlv.getValue().getData();
84          String oidValue = Strings.asciiBytesToString( value );
85  
86          // The OID is encoded as a String, not an Object Id
87          if ( !Oid.isOid( oidValue ) )
88          {
89              LOG.error( I18n.err( I18n.ERR_04098, Strings.dumpBytes( value ) ) );
90  
91              // This will generate a PROTOCOL_ERROR
92              throw new DecoderException( I18n.err( I18n.ERR_04099, oidValue ) );
93          }
94  
95          Message message = container.getMessage();
96  
97          Control control = container.getLdapCodecService().newControl( oidValue );
98  
99          message.addControl( control );
100 
101         // We can have an END transition
102         container.setGrammarEndAllowed( true );
103 
104         if ( IS_DEBUG )
105         {
106             LOG.debug( "Control OID : " + oidValue );
107         }
108     }
109 }