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
022import java.text.ParseException;
023
024import org.apache.directory.shared.ldap.model.constants.SchemaConstants;
025import org.apache.directory.shared.ldap.model.schema.SchemaManager;
026import org.apache.directory.shared.ldap.model.schema.SyntaxChecker;
027import org.apache.directory.shared.ldap.model.subtree.SubtreeSpecificationChecker;
028import org.apache.directory.shared.util.Strings;
029import org.slf4j.Logger;
030import org.slf4j.LoggerFactory;
031
032
033/**
034 * A SyntaxChecker which verifies that a value is a subtree specification.
035 * 
036 * It has been removed in RFC 4517
037 *  
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040@SuppressWarnings("serial")
041public class SubtreeSpecificationSyntaxChecker extends SyntaxChecker
042{
043    /** A logger for this class */
044    private static final Logger LOG = LoggerFactory.getLogger( SubtreeSpecificationSyntaxChecker.class );
045
046    /** The associated checker */ 
047    private SubtreeSpecificationChecker subtreeSpecificationChecker;
048
049    /**
050     * Creates an instance of SubtreeSpecificationSyntaxChecker
051     */
052    public SubtreeSpecificationSyntaxChecker()
053    {
054        super( SchemaConstants.SUBTREE_SPECIFICATION_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        if ( strValue.length() == 0 )
085        {
086            LOG.debug( "Syntax invalid for '{}'", value );
087            return false;
088        }
089
090        try
091        {
092            synchronized( subtreeSpecificationChecker )
093            {
094                subtreeSpecificationChecker.parse( strValue );
095            }
096            
097            LOG.debug( "Syntax valid for '{}'", value );
098            return true;
099        }
100        catch ( ParseException pe )
101        {
102            LOG.debug( "Syntax invalid for '{}'", value );
103            return false;
104        }
105    }
106
107
108    /**
109     * {@inheritDoc}
110     */
111    public void setSchemaManager( SchemaManager schemaManager )
112    {
113        subtreeSpecificationChecker = new SubtreeSpecificationChecker( schemaManager );
114    }
115}