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