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.ldapResult;
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.ldap.codec.api.LdapMessageContainer;
027import org.apache.directory.api.ldap.codec.api.MessageDecorator;
028import org.apache.directory.api.ldap.model.message.LdapResult;
029import org.apache.directory.api.ldap.model.message.Message;
030import org.apache.directory.api.ldap.model.message.ResultResponse;
031import org.apache.directory.api.util.Strings;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * The action used to set the LdapResult error message.
038 *
039 * <pre>
040 *  LDAPResult ::= SEQUENCE {
041 *     ...
042 *     errorMessage LDAPString,
043 *     ...
044 * </pre>
045 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
046 */
047public class StoreErrorMessage extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
048{
049    /** The logger */
050    private static final Logger LOG = LoggerFactory.getLogger( StoreErrorMessage.class );
051
052    /** Speedup for logs */
053    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
054
055
056    /**
057     * Instantiates a new error message action.
058     */
059    public StoreErrorMessage()
060    {
061        super( "Store error message" );
062    }
063
064
065    /**
066     * {@inheritDoc}
067     */
068    public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
069    {
070        // Get the Value and store it in the BindResponse
071        TLV tlv = container.getCurrentTLV();
072        String errorMessage = null;
073
074        // We have to handle the special case of a 0 length error
075        // message
076        if ( tlv.getLength() == 0 )
077        {
078            errorMessage = "";
079        }
080        else
081        {
082            errorMessage = Strings.utf8ToString( tlv.getValue().getData() );
083        }
084
085        ResultResponse response = ( ResultResponse ) container.getMessage();
086        LdapResult ldapResult = response.getLdapResult();
087        ldapResult.setDiagnosticMessage( errorMessage );
088
089        // We can have an END transition
090        container.setGrammarEndAllowed( true );
091
092        if ( IS_DEBUG )
093        {
094            LOG.debug( "The error message is : " + errorMessage );
095        }
096    }
097}