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