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