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.unbindRequest;
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.LdapMessageContainer;
028import org.apache.directory.api.ldap.codec.decorators.UnbindRequestDecorator;
029import org.apache.directory.api.ldap.model.message.UnbindRequest;
030import org.apache.directory.api.ldap.model.message.UnbindRequestImpl;
031import org.slf4j.Logger;
032import org.slf4j.LoggerFactory;
033
034
035/**
036 * The action used to initialize the UnbindRequest :
037 * <pre>
038 * LdapMessage ::= ... UnBindRequest ...
039 * unbindRequest ::= [APPLICATION 2] NULL
040 * </pre>
041 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
042 */
043public class InitUnbindRequest extends GrammarAction<LdapMessageContainer<UnbindRequestDecorator>>
044{
045    /** The logger */
046    private static final Logger LOG = LoggerFactory.getLogger( InitUnbindRequest.class );
047
048
049    /**
050     * Instantiates a new action.
051     */
052    public InitUnbindRequest()
053    {
054        super( "Unbind Request initialization" );
055    }
056
057
058    /**
059     * {@inheritDoc}
060     */
061    public void action( LdapMessageContainer<UnbindRequestDecorator> container ) throws DecoderException
062    {
063        // Create the UnbindRequest LdapMessage instance and store it in the container
064        UnbindRequest unbindRequestInternal = new UnbindRequestImpl();
065        unbindRequestInternal.setMessageId( container.getMessageId() );
066        UnbindRequestDecorator unbindRequest = new UnbindRequestDecorator(
067            container.getLdapCodecService(), unbindRequestInternal );
068        container.setMessage( unbindRequest );
069
070        TLV tlv = container.getCurrentTLV();
071        int expectedLength = tlv.getLength();
072
073        // The Length should be null
074        if ( expectedLength != 0 )
075        {
076            LOG.error( I18n.err( I18n.ERR_04071, Integer.valueOf( expectedLength ) ) );
077
078            // This will generate a PROTOCOL_ERROR
079            throw new DecoderException( I18n.err( I18n.ERR_04072 ) );
080        }
081
082        // We can quit now
083        container.setGrammarEndAllowed( true );
084    }
085}