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.SyntaxChecker;
027import org.apache.directory.api.ldap.model.schema.parsers.DitStructureRuleDescriptionSchemaParser;
028import org.apache.directory.api.util.Strings;
029import org.slf4j.Logger;
030import org.slf4j.LoggerFactory;
031
032
033/**
034 * A SyntaxChecker which verifies that a value follows the
035 * DIT structure rule descripton syntax according to RFC 4512, par 4.2.7.1:
036 * 
037 * <pre>
038 * DITStructureRuleDescription = LPAREN WSP
039 *   ruleid                     ; rule identifier
040 *   [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
041 *   [ SP "DESC" SP qdstring ]  ; description
042 *   [ SP "OBSOLETE" ]          ; not active
043 *   SP "FORM" SP oid           ; NameForm
044 *   [ SP "SUP" ruleids ]       ; superior rules
045 *   extensions WSP RPAREN      ; extensions
046 *
047 * ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN )
048 * ruleidlist = ruleid *( SP ruleid )
049 * ruleid = numbers
050 * </pre>
051 * 
052 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
053 */
054@SuppressWarnings("serial")
055public class DitStructureRuleDescriptionSyntaxChecker extends SyntaxChecker
056{
057    /** A logger for this class */
058    private static final Logger LOG = LoggerFactory.getLogger( DitStructureRuleDescriptionSyntaxChecker.class );
059
060    /** The schema parser used to parse the DITContentRuleDescription Syntax */
061    private DitStructureRuleDescriptionSchemaParser schemaParser = new DitStructureRuleDescriptionSchemaParser();
062
063
064    /**
065     * Creates a new instance of DITContentRuleDescriptionSyntaxChecker.
066     */
067    public DitStructureRuleDescriptionSyntaxChecker()
068    {
069        super( SchemaConstants.DIT_STRUCTURE_RULE_SYNTAX );
070    }
071
072
073    /**
074     * {@inheritDoc}
075     */
076    public boolean isValidSyntax( Object value )
077    {
078        String strValue = null;
079
080        if ( value == null )
081        {
082            LOG.debug( "Syntax invalid for 'null'" );
083            return false;
084        }
085
086        if ( value instanceof String )
087        {
088            strValue = ( String ) value;
089        }
090        else if ( value instanceof byte[] )
091        {
092            strValue = Strings.utf8ToString( ( byte[] ) value );
093        }
094        else
095        {
096            strValue = value.toString();
097        }
098
099        try
100        {
101            schemaParser.parseDITStructureRuleDescription( strValue );
102            LOG.debug( "Syntax valid for '{}'", value );
103            return true;
104        }
105        catch ( ParseException pe )
106        {
107            LOG.debug( "Syntax invalid for '{}'", value );
108            return false;
109        }
110    }
111}