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