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.i18n.I18n;
027import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
028import org.apache.directory.api.ldap.codec.api.MessageDecorator;
029import org.apache.directory.api.ldap.model.message.LdapResult;
030import org.apache.directory.api.ldap.model.message.Message;
031import org.apache.directory.api.ldap.model.message.Referral;
032import org.apache.directory.api.ldap.model.message.ReferralImpl;
033import org.apache.directory.api.ldap.model.message.ResultResponse;
034import org.slf4j.Logger;
035import org.slf4j.LoggerFactory;
036
037
038/**
039 * The action used to init referrals to a LdapResult :
040 * <pre>
041 * LDAPResult ::= SEQUENCE {
042 *     ...
043 *     referral   [3] Referral OPTIONNAL }
044 * </pre>
045 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
046 */
047public class InitReferrals extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
048{
049    /** The logger */
050    private static final Logger LOG = LoggerFactory.getLogger( InitReferrals.class );
051
052    /** Speedup for logs */
053    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
054
055
056    /**
057     * Instantiates a new init referrals action.
058     */
059    public InitReferrals()
060    {
061        super( "Init the referrals list" );
062    }
063
064
065    /**
066     * {@inheritDoc}
067     */
068    public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
069    {
070        TLV tlv = container.getCurrentTLV();
071
072        // If we hae a Referrals sequence, then it should not be empty
073        if ( tlv.getLength() == 0 )
074        {
075            String msg = I18n.err( I18n.ERR_04011 );
076            LOG.error( msg );
077
078            // This will generate a PROTOCOL_ERROR
079            throw new DecoderException( msg );
080        }
081
082        ResultResponse response = ( ResultResponse ) container.getMessage();
083        LdapResult ldapResult = response.getLdapResult();
084
085        Referral referral = new ReferralImpl();
086        ldapResult.setReferral( referral );
087
088        if ( IS_DEBUG )
089        {
090            LOG.debug( "Initialising a referrals list" );
091        }
092    }
093}