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.name.Dn;
025import org.apache.directory.shared.ldap.model.schema.SyntaxChecker;
026import org.apache.directory.shared.util.Strings;
027import org.slf4j.Logger;
028import org.slf4j.LoggerFactory;
029
030
031/**
032 * A SyntaxChecker which verifies that a value is a valid Dn. We just check
033 * that the Dn is valid, we don't need to verify each of the Rdn syntax.
034 * 
035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
036 */
037@SuppressWarnings("serial")
038public class DNSyntaxChecker extends SyntaxChecker
039{
040    /** A logger for this class */
041    private static final Logger LOG = LoggerFactory.getLogger( DNSyntaxChecker.class );
042
043    /**
044     * Creates a new instance of DNSyntaxChecker.
045     */
046    public DNSyntaxChecker()
047    {
048        super( SchemaConstants.DN_SYNTAX );
049    }
050
051    
052    /**
053     * {@inheritDoc}
054     */
055    public boolean isValidSyntax( Object value )
056    {
057        String strValue = null;
058
059        if ( value == null )
060        {
061            LOG.debug( "Syntax invalid for 'null'" );
062            return false;
063        }
064        
065        if ( value instanceof String )
066        {
067            strValue = ( String ) value;
068        }
069        else if ( value instanceof byte[] )
070        {
071            strValue = Strings.utf8ToString((byte[]) value);
072        }
073        else
074        {
075            strValue = value.toString();
076        }
077
078        if ( strValue.length() == 0 )
079        {
080            // TODO: this should be a false, but for 
081            // some reason, the principal is empty in 
082            // some cases.
083            LOG.debug( "Syntax valid for '{}'", value );
084            return true;
085        }
086        
087        // Check that the value is a valid Dn
088        boolean result = Dn.isValid(strValue);
089        
090        if ( result )
091        {
092            LOG.debug( "Syntax valid for '{}'", value );
093        }
094        else
095        {
096            LOG.debug( "Syntax invalid for '{}'", value );
097        }
098        
099        return result;
100    }
101}