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.model.schema.syntaxCheckers;
021
022
023import org.apache.directory.shared.ldap.model.constants.SchemaConstants;
024import org.apache.directory.shared.ldap.model.schema.SyntaxChecker;
025import org.apache.directory.shared.util.Strings;
026import org.slf4j.Logger;
027import org.slf4j.LoggerFactory;
028
029
030/**
031 * A SyntaxChecker which verifies that a value is a valid Search Scope. We
032 * have three possible values :
033 * <ul>
034 * <li>OBJECT</li>
035 * <li>ONE</li>
036 * <li>SUBTREE</li>
037 * </ul>
038 * The value is case insensitive
039 *
040 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
041 */
042@SuppressWarnings("serial")
043public class SearchScopeSyntaxChecker extends SyntaxChecker
044{
045    /** A logger for this class */
046    private static final Logger LOG = LoggerFactory.getLogger( SearchScopeSyntaxChecker.class );
047
048    /**
049     * Creates a new instance of SearchScopeSyntaxChecker.
050     */
051    public SearchScopeSyntaxChecker()
052    {
053        super( SchemaConstants.SEARCH_SCOPE_SYNTAX );
054    }
055    
056    
057    /**
058     * {@inheritDoc}
059     */
060    public boolean isValidSyntax( Object value )
061    {
062        String strValue = null;
063
064        if ( value == null )
065        {
066            LOG.debug( "Syntax invalid for 'null'" );
067            return false;
068        }
069        
070        if ( value instanceof String )
071        {
072            strValue = ( String ) value;
073        }
074        else if ( value instanceof byte[] )
075        {
076            strValue = Strings.utf8ToString((byte[]) value);
077        }
078        else
079        {
080            strValue = value.toString();
081        }
082
083        strValue = Strings.trim( Strings.toLowerCase( strValue ) );
084        
085        return ( "base".equals( strValue ) || "one".equals(  strValue ) || "sub".equals( strValue ) );
086    }
087}