/*
    *  Licensed to the Apache Software Foundation (ASF) under one
    *  or more contributor license agreements.  See the NOTICE file
    *  distributed with this work for additional information
    *  regarding copyright ownership.  The ASF licenses this file
    *  to you under the Apache License, Version 2.0 (the
    *  "License"); you may not use this file except in compliance
    *  with the License.  You may obtain a copy of the License at
    *
   *    http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing,
   *  software distributed under the License is distributed on an
   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *  KIND, either express or implied.  See the License for the
   *  specific language governing permissions and limitations
   *  under the License.
   *
   */
  package org.apache.directory.api.ldap.codec.actions.controls;
  
  
  import org.apache.directory.api.asn1.DecoderException;
  import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
  import org.apache.directory.api.asn1.ber.tlv.BerValue;
  import org.apache.directory.api.asn1.ber.tlv.TLV;
  import org.apache.directory.api.ldap.codec.api.CodecControl;
  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
  import org.apache.directory.api.ldap.codec.api.MessageDecorator;
  import org.apache.directory.api.ldap.model.message.Control;
  import org.apache.directory.api.ldap.model.message.Message;
  import org.apache.directory.api.util.Strings;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  
  /**
   * The action used to set the value of a control. This is an extension point
   * where different controls can be plugged in (at least eventually). For now we
   * hard code controls.
   * <pre>
   * Control ::= SEQUENCE {
   *     ...
   *     controlValue OCTET STRING OPTIONAL }
   * </pre>
   *
   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
   */
  public class StoreControlValue extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
  {
      /** The logger */
      private static final Logger LOG = LoggerFactory.getLogger( StoreControlValue.class );
  
      /** Speedup for logs */
      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
  
  
      /**
       * Instantiates a new StoreControlValue action.
       */
      public StoreControlValue()
      {
          super( "Store the control value" );
      }
  
  
      /**
       * {@inheritDoc}
       */
      public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
      {
          TLV tlv = container.getCurrentTLV();
  
          MessageDecorator<?> message = container.getMessage();
          CodecControl<? extends Control> control = message.getCurrentControl();
  
          // Get the current control
          BerValue value = tlv.getValue();
  
          // Store the value - have to handle the special case of a 0 length value
          if ( tlv.getLength() == 0 )
          {
              control.setValue( Strings.EMPTY_BYTES );
          }
          else
          {
              control.setValue( value.getData() );
              control.decode( value.getData() );
          }
  
          // We can have an END transition
          container.setGrammarEndAllowed( true );
  
          if ( IS_DEBUG )
          {
              LOG.debug( "Control value : " + Strings.dumpBytes( control.getValue() ) );
          }
      }
  }