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.shared.ldap.codec.actions.extendedRequest;
021
022
023import org.apache.directory.shared.asn1.DecoderException;
024import org.apache.directory.shared.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.shared.asn1.ber.tlv.TLV;
026import org.apache.directory.shared.ldap.codec.api.LdapMessageContainer;
027import org.apache.directory.shared.ldap.codec.api.ExtendedRequestDecorator;
028import org.apache.directory.shared.util.StringConstants;
029import org.slf4j.Logger;
030import org.slf4j.LoggerFactory;
031
032
033/**
034 * The action used to store the Extended Request value
035 * <pre>
036 * ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
037 *     ...
038 *     requestValue  [1] OCTET STRING OPTIONAL }
039 * </pre>
040 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
041 */
042public class StoreExtendedRequestValue extends GrammarAction<LdapMessageContainer<ExtendedRequestDecorator<?,?>>>
043{
044    /** The logger */
045    private static final Logger LOG = LoggerFactory.getLogger( StoreExtendedRequestValue.class );
046
047    /** Speedup for logs */
048    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
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    public void action( LdapMessageContainer<ExtendedRequestDecorator<?,?>> container ) throws DecoderException
063    {
064        // We can allocate the ExtendedRequest Object
065        ExtendedRequestDecorator<?,?> extendedRequest = container.getMessage();
066
067        // Get the Value and store it in the ExtendedRequest
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            extendedRequest.setRequestValue( StringConstants.EMPTY_BYTES );
075        }
076        else
077        {
078            extendedRequest.setRequestValue( tlv.getValue().getData() );
079        }
080
081        // We can have an END transition
082        container.setGrammarEndAllowed( true );
083
084        if ( IS_DEBUG )
085        {
086            LOG.debug( "Extended value : {}", extendedRequest.getRequestValue() );
087        }
088    }
089}