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     */
020    package org.apache.directory.shared.ldap.schema.syntaxCheckers;
021    
022    
023    import java.text.ParseException;
024    
025    import org.apache.directory.shared.ldap.constants.SchemaConstants;
026    import org.apache.directory.shared.ldap.schema.SyntaxChecker;
027    import org.apache.directory.shared.ldap.schema.parsers.DITStructureRuleDescriptionSchemaParser;
028    import org.apache.directory.shared.ldap.util.StringTools;
029    import org.slf4j.Logger;
030    import 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     * @version $Rev$
054     */
055    public class DITStructureRuleDescriptionSyntaxChecker extends SyntaxChecker
056    {
057        /** A logger for this class */
058        private static final Logger LOG = LoggerFactory.getLogger( DITStructureRuleDescriptionSyntaxChecker.class );
059    
060        /** The serialVersionUID */
061        private static final long serialVersionUID = 1L;
062    
063        /** The schema parser used to parse the DITContentRuleDescription Syntax */
064        private DITStructureRuleDescriptionSchemaParser schemaParser = new DITStructureRuleDescriptionSchemaParser();
065    
066    
067        /**
068         * Creates a new instance of DITContentRuleDescriptionSyntaxChecker.
069         */
070        public DITStructureRuleDescriptionSyntaxChecker()
071        {
072            super( SchemaConstants.DIT_STRUCTURE_RULE_SYNTAX );
073        }
074    
075    
076        /**
077         * {@inheritDoc}
078         */
079        public boolean isValidSyntax( Object value )
080        {
081            String strValue = null;
082    
083            if ( value == null )
084            {
085                LOG.debug( "Syntax invalid for '{}'", value );
086                return false;
087            }
088    
089            if ( value instanceof String )
090            {
091                strValue = ( String ) value;
092            }
093            else if ( value instanceof byte[] )
094            {
095                strValue = StringTools.utf8ToString( ( byte[] ) value );
096            }
097            else
098            {
099                strValue = value.toString();
100            }
101    
102            try
103            {
104                schemaParser.parseDITStructureRuleDescription( strValue );
105                LOG.debug( "Syntax valid for '{}'", value );
106                return true;
107            }
108            catch ( ParseException pe )
109            {
110                LOG.debug( "Syntax invalid for '{}'", value );
111                return false;
112            }
113        }
114    }