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.searchRequest;
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.LdapCodecConstants;
031import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
032import org.apache.directory.api.ldap.codec.decorators.SearchRequestDecorator;
033import org.apache.directory.api.ldap.model.message.AliasDerefMode;
034import org.apache.directory.api.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    /**
063     * Instantiates a new action.
064     */
065    public StoreSearchRequestDerefAlias()
066    {
067        super( "Store SearchRequest derefAlias flag" );
068    }
069
070
071    /**
072     * {@inheritDoc}
073     */
074    public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
075    {
076        SearchRequest searchRequest = container.getMessage().getDecorated();
077
078        TLV tlv = container.getCurrentTLV();
079
080        // We have to check that this is a correct derefAliases
081        BerValue value = tlv.getValue();
082        int derefAliases = 0;
083
084        try
085        {
086            derefAliases = IntegerDecoder.parse( value, LdapCodecConstants.NEVER_DEREF_ALIASES,
087                LdapCodecConstants.DEREF_ALWAYS );
088        }
089        catch ( IntegerDecoderException ide )
090        {
091            String msg = I18n.err( I18n.ERR_04102, value.toString() );
092            LOG.error( msg );
093            throw new DecoderException( msg, ide );
094        }
095
096        searchRequest.setDerefAliases( AliasDerefMode.getDerefMode( derefAliases ) );
097
098        if ( IS_DEBUG )
099        {
100            switch ( derefAliases )
101            {
102                case LdapCodecConstants.NEVER_DEREF_ALIASES:
103                    LOG.debug( "Handling object strategy : NEVER_DEREF_ALIASES" );
104                    break;
105
106                case LdapCodecConstants.DEREF_IN_SEARCHING:
107                    LOG.debug( "Handling object strategy : DEREF_IN_SEARCHING" );
108                    break;
109
110                case LdapCodecConstants.DEREF_FINDING_BASE_OBJ:
111                    LOG.debug( "Handling object strategy : DEREF_FINDING_BASE_OBJ" );
112                    break;
113
114                case LdapCodecConstants.DEREF_ALWAYS:
115                    LOG.debug( "Handling object strategy : DEREF_ALWAYS" );
116                    break;
117
118                default:
119                    LOG.debug( "Handling object strategy : UNKNOWN" );
120            }
121        }
122    }
123}