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 Boolean according to RFC 4517.
032 * 
033 * From RFC 4517 :
034 * 
035 * Boolean = "TRUE" / "FALSE"
036 * 
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040@SuppressWarnings("serial")
041public class BooleanSyntaxChecker extends SyntaxChecker
042{
043    /** A logger for this class */
044    private static final Logger LOG = LoggerFactory.getLogger( BooleanSyntaxChecker.class );
045
046    /**
047     * Creates a new instance of BooleanSyntaxChecker.
048     */
049    public BooleanSyntaxChecker()
050    {
051        super( SchemaConstants.BOOLEAN_SYNTAX );
052    }
053    
054    
055    /**
056     * {@inheritDoc}
057     */
058    public boolean isValidSyntax( Object value )
059    {
060        String strValue = null;
061
062        if ( value == null )
063        {
064            LOG.debug( "Syntax invalid for 'null'" );
065            return false;
066        }
067        
068        if ( value instanceof String )
069        {
070            strValue = ( String ) value;
071        }
072        else if ( value instanceof byte[] )
073        {
074            strValue = Strings.utf8ToString((byte[]) value);
075        }
076        else
077        {
078            strValue = value.toString();
079        }
080
081        if ( strValue.length() == 0 )
082        {
083            LOG.debug( "Syntax invalid for '{}'", strValue );
084            return false;
085        }
086        
087        boolean valid = ( ( "TRUE".equalsIgnoreCase( strValue ) ) || ( "FALSE".equalsIgnoreCase( strValue ) ) );
088        
089        if ( valid )
090        {
091            LOG.debug( "Syntax valid for '{}'", strValue );
092        }
093        else
094        {
095            LOG.debug( "Syntax invalid for '{}'", strValue );
096        }
097        
098        return valid;
099    }
100}