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 Directory String according to RFC 4517.
032 * 
033 * From RFC 4517 :
034 * DirectoryString = 1*UTF8
035 * 
036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037 */
038@SuppressWarnings("serial")
039public class DirectoryStringSyntaxChecker extends SyntaxChecker
040{
041    /** A logger for this class */
042    private static final Logger LOG = LoggerFactory.getLogger( DirectoryStringSyntaxChecker.class );
043
044
045    /**
046     * Creates a new instance of DirectoryStringSyntaxChecker.
047     */
048    public DirectoryStringSyntaxChecker()
049    {
050        super( SchemaConstants.DIRECTORY_STRING_SYNTAX );
051    }
052
053
054    /**
055     * {@inheritDoc}
056     */
057    public boolean isValidSyntax( Object value )
058    {
059        String strValue = null;
060
061        if ( value == null )
062        {
063            LOG.debug( "Syntax invalid for 'null'" );
064            return false;
065        }
066
067        if ( value instanceof String )
068        {
069            strValue = ( String ) value;
070        }
071        else if ( value instanceof byte[] )
072        {
073            strValue = Strings.utf8ToString( ( byte[] ) value );
074        }
075        else
076        {
077            strValue = value.toString();
078        }
079
080        // If the value was an invalid UTF8 string, then it's length
081        // will be 0 as the StringTools.utf8ToString() call will
082        // return an empty string
083        if ( strValue.length() == 0 )
084        {
085            LOG.debug( "Syntax invalid for '{}'", value );
086            return false;
087        }
088
089        // In any other case, we have to check that the
090        // string does not contains the '0xFFFD' character
091        for ( char c : strValue.toCharArray() )
092        {
093            if ( c == 0xFFFD )
094            {
095                LOG.debug( "Syntax invalid for '{}'", value );
096                return false;
097            }
098        }
099
100        LOG.debug( "Syntax valid for '{}'", value );
101        return true;
102    }
103}