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.i18n.I18n;
024import org.apache.directory.api.ldap.model.constants.SchemaConstants;
025import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
026import org.apache.directory.api.util.Strings;
027
028
029/**
030 * A SyntaxChecker which verifies that a value is a Boolean according to RFC 4517.
031 * <p>
032 * From RFC 4517 :
033 * 
034 * <pre>
035 * Boolean = "TRUE" / "FALSE"
036 * </pre>
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040@SuppressWarnings("serial")
041public final class BooleanSyntaxChecker extends SyntaxChecker
042{
043    /**
044     * A static instance of BooleanSyntaxChecker
045     */
046    public static final BooleanSyntaxChecker INSTANCE = new BooleanSyntaxChecker( SchemaConstants.BOOLEAN_SYNTAX );
047    
048    /**
049     * A static Builder for this class
050     */
051    public static final class Builder extends SCBuilder<BooleanSyntaxChecker>
052    {
053        /**
054         * The Builder constructor
055         */
056        private Builder()
057        {
058            super( SchemaConstants.BOOLEAN_SYNTAX );
059        }
060        
061        
062        /**
063         * Create a new instance of BooleanSyntaxChecker
064         * @return A new instance of BooleanSyntaxChecker
065         */
066        @Override
067        public BooleanSyntaxChecker build()
068        {
069            return new BooleanSyntaxChecker( oid );
070        }
071    }
072
073    
074    /**
075     * Creates a new instance of BooleanSyntaxChecker.
076     * 
077     * @param oid The OID to use for this SyntaxChecker
078     */
079    private BooleanSyntaxChecker( String oid )
080    {
081        super( oid );
082    }
083
084    
085    /**
086     * @return An instance of the Builder for this class
087     */
088    public static Builder builder()
089    {
090        return new Builder();
091    }
092
093
094    /**
095     * {@inheritDoc}
096     */
097    @Override
098    public boolean isValidSyntax( Object value )
099    {
100        String strValue;
101
102        if ( value == null )
103        {
104            if ( LOG.isDebugEnabled() )
105            {
106                LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, "null" ) );
107            }
108            
109            return false;
110        }
111
112        if ( value instanceof String )
113        {
114            strValue = ( String ) value;
115        }
116        else if ( value instanceof byte[] )
117        {
118            strValue = Strings.utf8ToString( ( byte[] ) value );
119        }
120        else
121        {
122            strValue = value.toString();
123        }
124
125        if ( strValue.length() == 0 )
126        {
127            if ( LOG.isDebugEnabled() )
128            {
129                LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, strValue ) );
130            }
131            
132            return false;
133        }
134
135        boolean valid = "TRUE".equalsIgnoreCase( strValue ) || "FALSE".equalsIgnoreCase( strValue );
136
137        if ( LOG.isDebugEnabled() )
138        {
139            if ( valid )
140            {
141                LOG.debug( I18n.msg( I18n.MSG_04489_SYNTAX_VALID, strValue ) );
142            }
143            else
144            {
145                LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, strValue ) );
146            }
147        }
148
149        return valid;
150    }
151}