001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.directory.api.ldap.codec.actions.response.intermediate;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.api.asn1.ber.tlv.TLV;
026import org.apache.directory.api.i18n.I18n;
027import org.apache.directory.api.ldap.codec.api.IntermediateOperationFactory;
028import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
029import org.apache.directory.api.ldap.model.message.IntermediateResponse;
030import org.apache.directory.api.util.Strings;
031import org.slf4j.Logger;
032import org.slf4j.LoggerFactory;
033
034
035/**
036 * The action used to store a IntermediateResponse value
037 * <pre>
038 * IntermediateResponse ::= [APPLICATION 25] SEQUENCE {
039 *     ...
040 *     responseValue [1] OCTET STRING OPTIONAL
041 *     }
042 * </pre>
043 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
044 */
045public class StoreIntermediateResponseValue extends GrammarAction<LdapMessageContainer<IntermediateResponse>>
046{
047    /** The logger */
048    private static final Logger LOG = LoggerFactory.getLogger( StoreIntermediateResponseValue.class );
049
050    /**
051     * Instantiates a new response name action.
052     */
053    public StoreIntermediateResponseValue()
054    {
055        super( "Store response value" );
056    }
057
058
059    /**
060     * {@inheritDoc}
061     */
062    public void action( LdapMessageContainer<IntermediateResponse> container ) throws DecoderException
063    {
064        // We can get the IntermediateResponse Object
065        IntermediateResponse intermediateResponse = container.getMessage();
066
067        // Get the Value and store it in the IntermediateResponse
068        TLV tlv = container.getCurrentTLV();
069
070        // We have to handle the special case of a 0 length matched
071        // value
072        if ( tlv.getLength() >= 0 )
073        {
074            // let's decode
075            IntermediateOperationFactory intermediateFactory = container.getIntermediateFactory();
076            
077            if ( intermediateFactory != null )
078            {
079                intermediateFactory.decodeValue( intermediateResponse, tlv.getValue().getData() );
080            }
081            else
082            {
083                intermediateResponse.setResponseValue( tlv.getValue().getData() );
084            }
085        }
086
087        // We can have an END transition
088        container.setGrammarEndAllowed( true );
089
090        if ( LOG.isDebugEnabled() )
091        {
092            LOG.debug( I18n.msg( I18n.MSG_05175_VALUE_READ, Strings.dumpBytes( intermediateResponse.getResponseValue() ) ) );
093        }
094    }
095}