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     */
020    package org.apache.directory.shared.ldap.codec.actions;
021    
022    
023    import org.apache.directory.shared.asn1.ber.IAsn1Container;
024    import org.apache.directory.shared.asn1.ber.grammar.GrammarAction;
025    import org.apache.directory.shared.asn1.ber.tlv.TLV;
026    import org.apache.directory.shared.asn1.codec.DecoderException;
027    import org.apache.directory.shared.asn1.primitives.OID;
028    import org.apache.directory.shared.i18n.I18n;
029    import org.apache.directory.shared.ldap.codec.LdapMessageContainer;
030    import org.apache.directory.shared.ldap.codec.extended.ExtendedResponseCodec;
031    import org.apache.directory.shared.ldap.util.StringTools;
032    import org.slf4j.Logger;
033    import org.slf4j.LoggerFactory;
034    
035    
036    /**
037     * The action used to store a Response Name to an ExtendedResponse
038     * 
039     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
040     * @version $Rev$, $Date$, 
041     */
042    public class ResponseNameAction extends GrammarAction
043    {
044        /** The logger */
045        private static final Logger log = LoggerFactory.getLogger( ResponseNameAction.class );
046    
047        /** Speedup for logs */
048        private static final boolean IS_DEBUG = log.isDebugEnabled();
049    
050        public ResponseNameAction()
051        {
052            super( "Store response name" );
053        }
054    
055        /**
056         * The initialization action
057         */
058        public void action( IAsn1Container container ) throws DecoderException
059        {
060            LdapMessageContainer ldapMessageContainer = ( LdapMessageContainer ) container;
061    
062            // We can allocate the ExtendedResponse Object
063            ExtendedResponseCodec extendedResponse = ldapMessageContainer.getExtendedResponse();
064    
065            // Get the Value and store it in the ExtendedResponse
066            TLV tlv = ldapMessageContainer.getCurrentTLV();
067    
068            // We have to handle the special case of a 0 length matched
069            // OID
070            if ( tlv.getLength() == 0 )
071            {
072                log.error( I18n.err( I18n.ERR_04017 ) );
073                throw new DecoderException( I18n.err( I18n.ERR_04017 ) );
074            }
075            else
076            {
077                extendedResponse
078                    .setResponseName( new OID( StringTools.asciiBytesToString( tlv.getValue().getData() ) ) );
079            }
080    
081            // We can have an END transition
082            ldapMessageContainer.grammarEndAllowed( true );
083    
084            if ( IS_DEBUG )
085            {
086                log.debug( "OID read : {}", extendedResponse.getResponseName() );
087            }
088        }
089    }