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.shared.ldap.codec.actions.searchRequest;
021
022
023import org.apache.directory.shared.asn1.DecoderException;
024import org.apache.directory.shared.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.shared.asn1.ber.tlv.IntegerDecoder;
026import org.apache.directory.shared.asn1.ber.tlv.IntegerDecoderException;
027import org.apache.directory.shared.asn1.ber.tlv.TLV;
028import org.apache.directory.shared.asn1.ber.tlv.Value;
029import org.apache.directory.shared.i18n.I18n;
030import org.apache.directory.shared.ldap.codec.api.LdapConstants;
031import org.apache.directory.shared.ldap.codec.api.LdapMessageContainer;
032import org.apache.directory.shared.ldap.codec.decorators.SearchRequestDecorator;
033import org.apache.directory.shared.ldap.model.message.AliasDerefMode;
034import org.apache.directory.shared.ldap.model.message.SearchRequest;
035import org.slf4j.Logger;
036import org.slf4j.LoggerFactory;
037
038
039/**
040 * The action used to store the SearchRequest derefAlias flag
041 * <pre>
042 * SearchRequest ::= [APPLICATION 3] SEQUENCE {
043 *     ...
044 *     derefAliases ENUMERATED {
045 *         neverDerefAliases   (0),
046 *         derefInSearching    (1),
047 *         derefFindingBaseObj (2),
048 *         derefAlways         (3) },
049 *     ...
050 * </pre>
051 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
052 */
053public class StoreSearchRequestDerefAlias extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
054{
055    /** The logger */
056    private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestDerefAlias.class );
057
058    /** Speedup for logs */
059    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
060
061    /**
062     * Instantiates a new action.
063     */
064    public StoreSearchRequestDerefAlias()
065    {
066        super( "Store SearchRequest derefAlias flag" );
067    }
068
069
070    /**
071     * {@inheritDoc}
072     */
073    public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
074    {
075        SearchRequest searchRequest = container.getMessage().getDecorated();
076
077        TLV tlv = container.getCurrentTLV();
078
079        // We have to check that this is a correct derefAliases
080        Value value = tlv.getValue();
081        int derefAliases = 0;
082
083        try
084        {
085            derefAliases = IntegerDecoder.parse(value, LdapConstants.NEVER_DEREF_ALIASES,
086                    LdapConstants.DEREF_ALWAYS);
087        }
088        catch ( IntegerDecoderException ide )
089        {
090            String msg = I18n.err( I18n.ERR_04102, value.toString() );
091            LOG.error( msg );
092            throw new DecoderException( msg );
093        }
094
095        searchRequest.setDerefAliases( AliasDerefMode.getDerefMode( derefAliases ) );
096
097        if ( IS_DEBUG )
098        {
099            switch ( derefAliases )
100            {
101                case LdapConstants.NEVER_DEREF_ALIASES:
102                    LOG.debug( "Handling object strategy : NEVER_DEREF_ALIASES" );
103                    break;
104
105                case LdapConstants.DEREF_IN_SEARCHING:
106                    LOG.debug( "Handling object strategy : DEREF_IN_SEARCHING" );
107                    break;
108
109                case LdapConstants.DEREF_FINDING_BASE_OBJ:
110                    LOG.debug( "Handling object strategy : DEREF_FINDING_BASE_OBJ" );
111                    break;
112
113                case LdapConstants.DEREF_ALWAYS:
114                    LOG.debug( "Handling object strategy : DEREF_ALWAYS" );
115                    break;
116            }
117        }
118    }
119}