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.model.schema.syntaxCheckers; 021 022 023import org.apache.directory.api.ldap.model.constants.SchemaConstants; 024import org.apache.directory.api.ldap.model.schema.SyntaxChecker; 025import org.apache.directory.api.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 /** 050 * Creates a new instance of SearchScopeSyntaxChecker. 051 */ 052 public SearchScopeSyntaxChecker() 053 { 054 super( SchemaConstants.SEARCH_SCOPE_SYNTAX ); 055 } 056 057 058 /** 059 * {@inheritDoc} 060 */ 061 public boolean isValidSyntax( Object value ) 062 { 063 String strValue = null; 064 065 if ( value == null ) 066 { 067 LOG.debug( "Syntax invalid for 'null'" ); 068 return false; 069 } 070 071 if ( value instanceof String ) 072 { 073 strValue = ( String ) value; 074 } 075 else if ( value instanceof byte[] ) 076 { 077 strValue = Strings.utf8ToString( ( byte[] ) value ); 078 } 079 else 080 { 081 strValue = value.toString(); 082 } 083 084 strValue = Strings.trim( Strings.toLowerCase( strValue ) ); 085 086 return ( "base".equals( strValue ) || "one".equals( strValue ) || "sub".equals( strValue ) ); 087 } 088}