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