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.BerValue;
026import org.apache.directory.api.asn1.ber.tlv.IntegerDecoder;
027import org.apache.directory.api.asn1.ber.tlv.IntegerDecoderException;
028import org.apache.directory.api.asn1.ber.tlv.TLV;
029import org.apache.directory.api.i18n.I18n;
030import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
031import org.apache.directory.api.ldap.codec.api.MessageDecorator;
032import org.apache.directory.api.ldap.model.message.LdapResult;
033import org.apache.directory.api.ldap.model.message.Message;
034import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
035import org.apache.directory.api.ldap.model.message.ResultResponse;
036import org.apache.directory.api.util.Strings;
037import org.slf4j.Logger;
038import org.slf4j.LoggerFactory;
039
040
041/**
042 * The action used to set the LdapResult result code.
043 * <pre>
044 * LDAPResult ::= SEQUENCE {
045 *     resultCode ENUMERATED {
046 *         ...
047 * </pre>
048 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
049 */
050public class StoreResultCode extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
051{
052    /** The logger */
053    private static final Logger LOG = LoggerFactory.getLogger( StoreResultCode.class );
054
055    /** Speedup for logs */
056    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
057
058
059    /**
060     * Instantiates a new result code action.
061     */
062    public StoreResultCode()
063    {
064        super( "Store resultCode" );
065    }
066
067
068    /**
069     * {@inheritDoc}
070     */
071    public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
072    {
073        // The current TLV should be a integer
074        // We get it and store it in MessageId
075        TLV tlv = container.getCurrentTLV();
076
077        BerValue value = tlv.getValue();
078        ResultCodeEnum resultCode = ResultCodeEnum.SUCCESS;
079
080        try
081        {
082            resultCode = ResultCodeEnum.getResultCode( IntegerDecoder.parse( value, 0,
083                ResultCodeEnum.E_SYNC_REFRESH_REQUIRED
084                    .getResultCode() ) );
085        }
086        catch ( IntegerDecoderException ide )
087        {
088            LOG.error( I18n.err( I18n.ERR_04018, Strings.dumpBytes( value.getData() ), ide.getMessage() ) );
089
090            throw new DecoderException( ide.getMessage(), ide );
091        }
092
093        if ( IS_DEBUG )
094        {
095            LOG.debug( "The result code is set to " + resultCode );
096        }
097
098        ResultResponse response = ( ResultResponse ) container.getMessage();
099        LdapResult ldapResult = response.getLdapResult();
100        ldapResult.setResultCode( resultCode );
101    }
102}