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.extendedRequest;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator;
026import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
027import org.slf4j.Logger;
028import org.slf4j.LoggerFactory;
029
030
031/**
032 * The action used to initialize the ExtendedRequest message
033 * <pre>
034 * LdapMessage ::= ... ExtendedRequest ...
035 * ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
036 * </pre>
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 */
039public class InitExtendedRequest extends GrammarAction<LdapMessageContainer<ExtendedRequestDecorator<?>>>
040{
041    /** The logger */
042    private static final Logger LOG = LoggerFactory.getLogger( InitExtendedRequest.class );
043
044
045    /**
046     * Instantiates a new action.
047     */
048    public InitExtendedRequest()
049    {
050        super( "Init ExtendedRequest" );
051    }
052
053
054    /**
055     * {@inheritDoc}
056     */
057    public void action( LdapMessageContainer<ExtendedRequestDecorator<?>> container ) throws DecoderException
058    {
059        /*
060         * It is the responsibility of the LdapCodecService to instantiate new
061         * extended requests and responses. So we must delegate this task over
062         * to it instead of creating the requests and responses manually. This
063         * is because we use a plugin model that allows us to use specific 
064         * types for extended requests and responses rather than using a 
065         * generic type.
066         * 
067         * So we have to wait until we at least get our hands on ExtendedRequest 
068         * OID before we can delegate instantiation to the LdapCodecService.
069         */
070
071        LOG.debug( "Extended request being processed ..." );
072    }
073}