ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/request/unbind/InitUnbindRequest.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 *
 */
package org.apache.directory.api.ldap.codec.actions.request.unbind;


import org.apache.directory.api.asn1.DecoderException;
import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
import org.apache.directory.api.asn1.ber.tlv.TLV;
import org.apache.directory.api.i18n.I18n;
import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
import org.apache.directory.api.ldap.model.message.UnbindRequest;
import org.apache.directory.api.ldap.model.message.UnbindRequestImpl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * The action used to initialize the UnbindRequest :
 * <pre>
 * LdapMessage ::= ... UnBindRequest ...
 * unbindRequest ::= [APPLICATION 2] NULL
 * </pre>
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class InitUnbindRequest extends GrammarAction<LdapMessageContainer<UnbindRequest>>
{
    /** The logger */
    private static final Logger LOG = LoggerFactory.getLogger( InitUnbindRequest.class );


    /**
     * Instantiates a new action.
     */
    public InitUnbindRequest()
    {
        super( "Unbind Request initialization" );
    }


    /**
     * {@inheritDoc}
     */
    public void action( LdapMessageContainer<UnbindRequest> container ) throws DecoderException
    {
        // Create the UnbindRequest LdapMessage instance and store it in the container
        UnbindRequest unbindRequest = new UnbindRequestImpl();
        unbindRequest.setMessageId( container.getMessageId() );
        container.setMessage( unbindRequest );

        TLV tlv = container.getCurrentTLV();
        int expectedLength = tlv.getLength();

        // The Length should be null
        if ( expectedLength != 0 )
        {
            LOG.error( I18n.err( I18n.ERR_05130_NON_NULL_UNBIND_LENGTH, Integer.valueOf( expectedLength ) ) );

            // This will generate a PROTOCOL_ERROR
            throw new DecoderException( I18n.err( I18n.ERR_05131_UNBIND_REQUEST_LENGTH_MUST_BE_NULL ) );
        }

        // We can quit now
        container.setGrammarEndAllowed( true );
    }
}