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.parsers;
021    
022    
023    import java.text.ParseException;
024    
025    import org.apache.directory.shared.i18n.I18n;
026    import org.apache.directory.shared.ldap.schema.MatchingRule;
027    import org.slf4j.Logger;
028    import org.slf4j.LoggerFactory;
029    
030    import antlr.RecognitionException;
031    import antlr.TokenStreamException;
032    
033    
034    /**
035     * A parser for RFC 4512 matching rule descriptions.
036     * 
037     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038     * @version $Rev$, $Date$
039     */
040    public class MatchingRuleDescriptionSchemaParser extends AbstractSchemaParser
041    {
042        /** The LoggerFactory used by this class */
043        protected static final Logger LOG = LoggerFactory.getLogger( MatchingRuleDescriptionSchemaParser.class );
044    
045        /**
046         * Creates a schema parser instance.
047         */
048        public MatchingRuleDescriptionSchemaParser()
049        {
050        }
051    
052    
053        /**
054         * Parses a matching rule description according to RFC 4512:
055         * 
056         * <pre>
057         * MatchingRuleDescription = LPAREN WSP
058         *    numericoid                 ; object identifier
059         *    [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
060         *    [ SP "DESC" SP qdstring ]  ; description
061         *    [ SP "OBSOLETE" ]          ; not active
062         *    SP "SYNTAX" SP numericoid  ; assertion syntax
063         *    extensions WSP RPAREN      ; extensions
064         * 
065         * extensions = *( SP xstring SP qdstrings )
066         * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 
067         * </pre>
068         * 
069         * @param matchingRuleDescription the matching rule description to be parsed
070         * @return the parsed MatchingRuleDescription bean
071         * @throws ParseException if there are any recognition errors (bad syntax)
072         */
073        public synchronized MatchingRule parseMatchingRuleDescription( String matchingRuleDescription )
074            throws ParseException
075        {
076            LOG.debug( "Parsing a MatchingRule : {}", matchingRuleDescription );
077    
078            if ( matchingRuleDescription == null )
079            {
080                LOG.error( I18n.err( I18n.ERR_04242 ) );
081                throw new ParseException( "Null", 0 );
082            }
083    
084            reset( matchingRuleDescription ); // reset and initialize the parser / lexer pair
085    
086            try
087            {
088                MatchingRule matchingRule = parser.matchingRuleDescription();
089                
090                // Update the schemaName
091                setSchemaName( matchingRule );
092    
093                return matchingRule;
094            }
095            catch ( RecognitionException re )
096            {
097                String msg = I18n.err( I18n.ERR_04243, matchingRuleDescription, re.getMessage(), re.getColumn() );
098                LOG.error( msg );
099                throw new ParseException( msg, re.getColumn() );
100            }
101            catch ( TokenStreamException tse )
102            {
103                String msg = I18n.err( I18n.ERR_04244, matchingRuleDescription, tse.getMessage() );
104                LOG.error( msg );
105                throw new ParseException( msg, 0 );
106            }
107        }
108    
109    
110        /**
111         * Parses a MatchingRule description
112         * 
113         * @param The MatchingRule description to parse
114         * @return An instance of MatchingRule
115         */
116        public MatchingRule parse( String schemaDescription ) throws ParseException
117        {
118            return parseMatchingRuleDescription( schemaDescription );
119        }
120    }