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.extended;
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.ExtendedOperationFactory;
028import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
029import org.apache.directory.api.ldap.model.message.ExtendedResponse;
030import org.apache.directory.api.ldap.model.message.OpaqueExtendedResponse;
031import org.apache.directory.api.util.Strings;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * The action used to store a Response to an ExtendedResponse
038 * <pre>
039 * ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
040 *     ...
041 *     response       [11] OCTET STRING OPTIONAL}
042 * </pre>
043 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
044 */
045public class StoreExtendedResponseValue extends GrammarAction<LdapMessageContainer<ExtendedResponse>>
046{
047    /** The logger */
048    private static final Logger LOG = LoggerFactory.getLogger( StoreExtendedResponseValue.class );
049
050    /**
051     * Instantiates a new response action.
052     */
053    public StoreExtendedResponseValue()
054    {
055        super( "Store response value" );
056    }
057
058
059    /**
060     * {@inheritDoc}
061     */
062    public void action( LdapMessageContainer<ExtendedResponse> container ) throws DecoderException
063    {
064        // We can allocate the ExtendedResponse Object
065        ExtendedResponse extendedResponse = container.getMessage();
066
067        // Get the Value and store it in the ExtendedResponse
068        TLV tlv = container.getCurrentTLV();
069        
070        ExtendedOperationFactory factory = container.getExtendedFactory();
071
072        // We have to handle the special case of a 0 length matched value
073        try
074        {
075            if ( factory == null )
076            {
077                if ( tlv.getLength() == 0 )
078                {
079                    ( ( OpaqueExtendedResponse ) extendedResponse ).setResponseValue( Strings.EMPTY_BYTES );
080                }
081                else
082                {
083                    ( ( OpaqueExtendedResponse ) extendedResponse ).setResponseValue( tlv.getValue().getData() );
084                }
085            }
086            else
087            {
088                factory.decodeValue( extendedResponse, tlv.getValue().getData() );
089            }
090        }
091        catch ( DecoderException de )
092        {
093            String msg = I18n.err( I18n.ERR_05158_INVALID_REQUEST_VALUE,
094                Strings.dumpBytes( tlv.getValue().getData() ) );
095            LOG.error( I18n.err( I18n.ERR_05114_ERROR_MESSAGE, msg, de.getMessage() ) );
096
097            // Rethrow the exception, we will get a PROTOCOL_ERROR
098            throw de;
099        }
100
101        // We can have an END transition
102        container.setGrammarEndAllowed( true );
103
104        if ( LOG.isDebugEnabled() )
105        {
106            LOG.debug( I18n.msg( I18n.MSG_05173_EXTENDED_VALUE, Strings.dumpBytes( tlv.getValue().getData() ) ) );
107        }
108    }
109}