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 java.text.ParseException;
024
025import org.apache.directory.api.ldap.model.constants.SchemaConstants;
026import org.apache.directory.api.ldap.model.schema.SchemaManager;
027import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
028import org.apache.directory.api.ldap.model.subtree.SubtreeSpecificationChecker;
029import org.apache.directory.api.util.Strings;
030import org.slf4j.Logger;
031import org.slf4j.LoggerFactory;
032
033
034/**
035 * A SyntaxChecker which verifies that a value is a subtree specification.
036 * 
037 * It has been removed in RFC 4517
038 *  
039 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
040 */
041@SuppressWarnings("serial")
042public class SubtreeSpecificationSyntaxChecker extends SyntaxChecker
043{
044    /** A logger for this class */
045    private static final Logger LOG = LoggerFactory.getLogger( SubtreeSpecificationSyntaxChecker.class );
046
047    /** The associated checker */
048    private SubtreeSpecificationChecker subtreeSpecificationChecker;
049
050
051    /**
052     * Creates an instance of SubtreeSpecificationSyntaxChecker
053     */
054    public SubtreeSpecificationSyntaxChecker()
055    {
056        super( SchemaConstants.SUBTREE_SPECIFICATION_SYNTAX );
057    }
058
059
060    /**
061     * {@inheritDoc}
062     */
063    public boolean isValidSyntax( Object value )
064    {
065        String strValue = null;
066
067        if ( value == null )
068        {
069            LOG.debug( "Syntax invalid for 'null'" );
070            return false;
071        }
072
073        if ( value instanceof String )
074        {
075            strValue = ( String ) value;
076        }
077        else if ( value instanceof byte[] )
078        {
079            strValue = Strings.utf8ToString( ( byte[] ) value );
080        }
081        else
082        {
083            strValue = value.toString();
084        }
085
086        if ( strValue.length() == 0 )
087        {
088            LOG.debug( "Syntax invalid for '{}'", value );
089            return false;
090        }
091
092        try
093        {
094            synchronized ( subtreeSpecificationChecker )
095            {
096                subtreeSpecificationChecker.parse( strValue );
097            }
098
099            LOG.debug( "Syntax valid for '{}'", value );
100            return true;
101        }
102        catch ( ParseException pe )
103        {
104            LOG.debug( "Syntax invalid for '{}'", value );
105            return false;
106        }
107    }
108
109
110    /**
111     * {@inheritDoc}
112     */
113    public void setSchemaManager( SchemaManager schemaManager )
114    {
115        subtreeSpecificationChecker = new SubtreeSpecificationChecker( schemaManager );
116    }
117}