/*
    *  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
    *
   *    https://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.request.search;
  
  
  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.BooleanDecoder;
  import org.apache.directory.api.asn1.ber.tlv.BooleanDecoderException;
  import org.apache.directory.api.asn1.ber.tlv.TLV;
  import org.apache.directory.api.i18n.I18n;
  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
  import org.apache.directory.api.ldap.model.message.SearchRequest;
  import org.apache.directory.api.util.Strings;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  
  /**
   * The action used to store the SearchRequest typesOnly flag
   * <pre>
   * SearchRequest ::= [APPLICATION 3] SEQUENCE {
   *     ...
   *     typesOnly BOOLEAN,
   *     ...
   * </pre>
   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
   */
  public class StoreSearchRequestTypesOnly extends GrammarAction<LdapMessageContainer<SearchRequest>>
  {
      /** The logger */
      private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestTypesOnly.class );
  
      /**
       * Instantiates a new action.
       */
      public StoreSearchRequestTypesOnly()
      {
          super( "Store SearchRequest typesOnly flag" );
      }
  
  
      /**
       * {@inheritDoc}
       */
      public void action( LdapMessageContainer<SearchRequest> container ) throws DecoderException
      {
          SearchRequest searchRequest = container.getMessage();
  
          TLV tlv = container.getCurrentTLV();
  
          // We get the value. If it's a 0, it's a FALSE. If it's
          // a FF, it's a TRUE. Any other value should be an error,
          // but we could relax this constraint. So if we have
          // something
          // which is not 0, it will be interpreted as TRUE, but we
          // will generate a warning.
          BerValue value = tlv.getValue();
  
          try
          {
              searchRequest.setTypesOnly( BooleanDecoder.parse( value ) );
          }
          catch ( BooleanDecoderException bde )
          {
              LOG.error( I18n
                  .err( I18n.ERR_05155_FLAG_TYPE_INVALID, Strings.dumpBytes( value.getData() ), bde.getMessage() ) );
  
              throw new DecoderException( bde.getMessage(), bde );
          }
  
          if ( LOG.isDebugEnabled() )
          {
              LOG.debug( I18n.msg( I18n.MSG_05165_SEARCH_RETURN_TYPE_ONLY ) );
          }
      }
  }