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.ldap.codec.LdapMessageContainer;
028    import org.apache.directory.shared.ldap.codec.LdapResponseCodec;
029    import org.apache.directory.shared.ldap.codec.LdapResultCodec;
030    import org.apache.directory.shared.ldap.util.StringTools;
031    import org.slf4j.Logger;
032    import org.slf4j.LoggerFactory;
033    
034    
035    /**
036     * The action used to set the LdapResult error message.
037     * 
038     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039     * @version $Rev$, $Date$, 
040     */
041    public class ErrorMessageAction extends GrammarAction
042    {
043        /** The logger */
044        private static final Logger log = LoggerFactory.getLogger( ErrorMessageAction.class );
045    
046        /** Speedup for logs */
047        private static final boolean IS_DEBUG = log.isDebugEnabled();
048    
049        public ErrorMessageAction()
050        {
051            super( "Store error message" );
052        }
053    
054        /**
055         * The initialization action
056         */
057        public void action( IAsn1Container container ) throws DecoderException
058        {
059            LdapMessageContainer ldapMessageContainer = ( LdapMessageContainer ) container;
060            LdapResponseCodec response = ldapMessageContainer.getLdapResponse();
061            LdapResultCodec ldapResult = response.getLdapResult();
062    
063            // Get the Value and store it in the BindResponse
064            TLV tlv = ldapMessageContainer.getCurrentTLV();
065    
066            // We have to handle the special case of a 0 length error
067            // message
068            if ( tlv.getLength() == 0 )
069            {
070                ldapResult.setErrorMessage( "" );
071            }
072            else
073            {
074                ldapResult.setErrorMessage( StringTools.utf8ToString( tlv.getValue().getData() ) );
075            }
076    
077            // We can have an END transition
078            ldapMessageContainer.grammarEndAllowed( true );
079    
080            if ( IS_DEBUG )
081            {
082                log.debug( "The error message is : " + ldapResult.getErrorMessage() );
083            }
084    
085            return;
086        }
087    }