/*
    *  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.response.intermediate;
  
  
  import org.apache.directory.api.asn1.DecoderException;
  import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
  import org.apache.directory.api.asn1.ber.tlv.TLV;
  import org.apache.directory.api.asn1.util.Oid;
  import org.apache.directory.api.i18n.I18n;
  import org.apache.directory.api.ldap.codec.api.IntermediateOperationFactory;
  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
  import org.apache.directory.api.ldap.model.message.Control;
  import org.apache.directory.api.ldap.model.message.IntermediateResponse;
  import org.apache.directory.api.ldap.model.message.LdapResult;
  import org.apache.directory.api.util.Strings;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  
  /**
   * The action used to store a IntermediateResponse Name
   * <pre>
   * IntermediateResponse ::= [APPLICATION 25] SEQUENCE {
   *     responseName [0] LDAPOID OPTIONAL,
   * </pre>
   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
   */
  public class StoreIntermediateResponseName extends GrammarAction<LdapMessageContainer<IntermediateResponse>>
  {
      /** The logger */
      private static final Logger LOG = LoggerFactory.getLogger( StoreIntermediateResponseName.class );
  
      /**
       * Instantiates a new response name action.
       */
      public StoreIntermediateResponseName()
      {
          super( "Store response name" );
      }
  
  
      /**
       * {@inheritDoc}
       */
      public void action( LdapMessageContainer<IntermediateResponse> container ) throws DecoderException
      {
          // We can get the IntermediateResponse Object
          IntermediateResponse intermediateResponse = container.getMessage();
  
          // Get the Value and store it in the IntermediateResponse
          TLV tlv = container.getCurrentTLV();
  
          // We have to handle the special case of a 0 length matched
          // OID.
          if ( tlv.getLength() == 0 )
          {
              String msg = I18n.err( I18n.ERR_05122_NULL_NAME );
              LOG.error( msg );
              // This will generate a PROTOCOL_ERROR
              throw new DecoderException( msg );
          }
          else
          {
              byte[] responseNameBytes = tlv.getValue().getData();
  
              // Check if the OID is valid
              String oidStr = Strings.utf8ToString( responseNameBytes );
  
              if ( Oid.isOid( oidStr ) )
              {
                  // Get the factory
                  IntermediateOperationFactory intermediateFactory = 
                      container.getLdapCodecService().getIntermediateResponseFactories().get( oidStr );
                  
                  if ( intermediateFactory != null )
                  {
                      // Ok, let's create the new operation, which will replace
                      // the one created during the init phase
                      IntermediateResponse newIntermediateResponse = intermediateFactory.newResponse();
                      newIntermediateResponse.setMessageId( intermediateResponse.getMessageId() );
                      
                     // Copy the LdapResult 
                     LdapResult ldapResult = intermediateResponse.getLdapResult();
                     newIntermediateResponse.getLdapResult().setDiagnosticMessage( ldapResult.getDiagnosticMessage() );
                     newIntermediateResponse.getLdapResult().setMatchedDn( ldapResult.getMatchedDn() );
                     newIntermediateResponse.getLdapResult().setReferral( ldapResult.getReferral() );
                     newIntermediateResponse.getLdapResult().setResultCode( ldapResult.getResultCode() );
                     
                     // Copy the controls
                     for ( Control control : intermediateResponse.getControls().values() )
                     {
                         newIntermediateResponse.addControl( control );
                     }
                     
                     container.setMessage( newIntermediateResponse );
                     container.setIntermediateFactory( intermediateFactory );
                 }
                 else
                 {
                     // We simply store the OID in teh existing message
                     intermediateResponse.setResponseName( oidStr );
                 }
             }
             else
             {
                 String msg = I18n.err( I18n.ERR_05133_INTERMEDIATE_RESPONSE_INVALID_OID, Strings.utf8ToString( responseNameBytes ), 
                     Strings.dumpBytes( responseNameBytes ) );
                 LOG.error( I18n.err( I18n.ERR_05114_ERROR_MESSAGE, msg, oidStr ) );
 
                 // Rethrow the exception, we will get a PROTOCOL_ERROR
                 throw new DecoderException( msg );
             }
         }
 
         // We can have an END transition
         container.setGrammarEndAllowed( true );
 
         if ( LOG.isDebugEnabled() )
         {
             LOG.debug( I18n.msg( I18n.MSG_05172_OID_READ, intermediateResponse.getResponseName() ) );
         }
     }
 }