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.extendedResponse;
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.asn1.util.Oid;
027import org.apache.directory.api.i18n.I18n;
028import org.apache.directory.api.ldap.codec.api.ExtendedResponseDecorator;
029import org.apache.directory.api.ldap.codec.api.LdapApiServiceFactory;
030import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
031import org.apache.directory.api.ldap.codec.decorators.LdapResultDecorator;
032import org.apache.directory.api.ldap.model.message.ExtendedResponse;
033import org.apache.directory.api.util.Strings;
034import org.slf4j.Logger;
035import org.slf4j.LoggerFactory;
036
037
038/**
039 * The action used to store a Response Name to an ExtendedResponse
040 * <pre>
041 * LdapMessage ::= ... ExtendedResponse ...
042 * ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
043 *     COMPONENTS OF LDAPResult,
044 *     responseName   [10] LDAPOID OPTIONAL,
045 *     ...
046 * </pre>
047 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
048 */
049public class StoreExtendedResponseName extends GrammarAction<LdapMessageContainer<ExtendedResponseDecorator<?>>>
050{
051    /** The logger */
052    private static final Logger LOG = LoggerFactory.getLogger( StoreExtendedResponseName.class );
053
054    /** Speedup for logs */
055    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
056
057
058    /**
059     * Instantiates a new response name action.
060     */
061    public StoreExtendedResponseName()
062    {
063        super( "Store response name" );
064    }
065
066
067    /**
068     * {@inheritDoc}
069     */
070    public void action( LdapMessageContainer<ExtendedResponseDecorator<?>> container ) throws DecoderException
071    {
072        // We can allocate the ExtendedResponse Object
073        ExtendedResponse extendedResponse = null;
074
075        // Get the Value and store it in the ExtendedResponse
076        TLV tlv = container.getCurrentTLV();
077
078        // We have to handle the special case of a 0 length matched
079        // OID
080        if ( tlv.getLength() == 0 )
081        {
082            String msg = I18n.err( I18n.ERR_04017 );
083            LOG.error( msg );
084            throw new DecoderException( msg );
085        }
086        else
087        {
088            String responseName = Oid.fromString( Strings.asciiBytesToString( tlv.getValue().getData() ) )
089                .toString();
090
091            extendedResponse = LdapApiServiceFactory.getSingleton().newExtendedResponse( responseName,
092                container.getMessageId(), null );
093            
094            ( ( ExtendedResponseDecorator<?> ) extendedResponse ).setLdapResult( ( ( LdapResultDecorator ) ( container
095                .getMessage().getLdapResult() ) ) );
096            container.setMessage( LdapApiServiceFactory.getSingleton().decorate( extendedResponse ) );
097        }
098
099        // We can have an END transition
100        container.setGrammarEndAllowed( true );
101
102        if ( IS_DEBUG )
103        {
104            LOG.debug( "OID read : {}", extendedResponse.getResponseName() );
105        }
106    }
107}