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.SearchRequest;
034import org.apache.directory.api.ldap.model.message.SearchScope;
035import org.slf4j.Logger;
036import org.slf4j.LoggerFactory;
037
038
039/**
040 * The action used to store the SearchRequest scope
041 * <pre>
042 * SearchRequest ::= [APPLICATION 3] SEQUENCE {
043 *     ...
044 *     scope ENUMERATED {
045 *         baseObject   (0),
046 *         singleLevel  (1),
047 *         wholeSubtree (2) },
048 *     ...
049 * </pre>
050 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
051 */
052public class StoreSearchRequestScope extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
053{
054    /** The logger */
055    private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestScope.class );
056
057    /** Speedup for logs */
058    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
059
060
061    /**
062     * Instantiates a new action.
063     */
064    public StoreSearchRequestScope()
065    {
066        super( "Store SearchRequest scope" );
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 scope
080        BerValue value = tlv.getValue();
081        int scope = 0;
082
083        try
084        {
085            scope = IntegerDecoder.parse( value, LdapCodecConstants.SCOPE_BASE_OBJECT,
086                LdapCodecConstants.SCOPE_WHOLE_SUBTREE );
087        }
088        catch ( IntegerDecoderException ide )
089        {
090            String msg = I18n.err( I18n.ERR_04101, value.toString() );
091            LOG.error( msg );
092            throw new DecoderException( msg, ide );
093        }
094
095        searchRequest.setScope( SearchScope.getSearchScope( scope ) );
096
097        if ( IS_DEBUG )
098        {
099            switch ( scope )
100            {
101                case LdapCodecConstants.SCOPE_BASE_OBJECT:
102                    LOG.debug( "Searching within BASE_OBJECT scope " );
103                    break;
104
105                case LdapCodecConstants.SCOPE_SINGLE_LEVEL:
106                    LOG.debug( "Searching within SINGLE_LEVEL scope " );
107                    break;
108
109                case LdapCodecConstants.SCOPE_WHOLE_SUBTREE:
110                    LOG.debug( "Searching within WHOLE_SUBTREE scope " );
111                    break;
112
113                default:
114                    LOG.debug( "Searching within UNKNOWN scope " );
115            }
116        }
117    }
118}