| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| */ |
| package org.apache.directory.shared.ldap.schema.parsers; |
| |
| |
| import java.text.ParseException; |
| |
| import org.apache.directory.shared.i18n.I18n; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import antlr.RecognitionException; |
| import antlr.TokenStreamException; |
| |
| |
| /** |
| * A parser for ApacheDS syntax checker descriptions. |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| public class SyntaxCheckerDescriptionSchemaParser extends AbstractSchemaParser |
| { |
| /** The LoggerFactory used by this class */ |
| protected static final Logger LOG = LoggerFactory.getLogger( SyntaxCheckerDescriptionSchemaParser.class ); |
| |
| |
| /** |
| * Creates a schema parser instance. |
| */ |
| public SyntaxCheckerDescriptionSchemaParser() |
| { |
| super(); |
| } |
| |
| |
| /** |
| * Parses a syntax checker description: |
| * |
| * <pre> |
| * SyntaxCheckerDescription = LPAREN WSP |
| * numericoid ; object identifier |
| * [ SP "DESC" SP qdstring ] ; description |
| * SP "FQCN" SP fqcn ; fully qualified class name |
| * [ SP "BYTECODE" SP base64 ] ; optional base64 encoded bytecode |
| * extensions WSP RPAREN ; extensions |
| * |
| * base64 = *(4base64-char) |
| * base64-char = ALPHA / DIGIT / "+" / "/" |
| * fqcn = fqcnComponent 1*( DOT fqcnComponent ) |
| * fqcnComponent = ??? |
| * |
| * extensions = *( SP xstring SP qdstrings ) |
| * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) |
| * </pre> |
| * |
| * @param syntaxCheckerDescription the syntax checker description to be parsed |
| * @return the parsed SyntaxCheckerDescription bean |
| * @throws ParseException if there are any recognition errors (bad syntax) |
| */ |
| public synchronized SyntaxCheckerDescription parseSyntaxCheckerDescription( String syntaxCheckerDescription ) |
| throws ParseException |
| { |
| LOG.debug( "Parsing a SyntaxChecker : {}", syntaxCheckerDescription ); |
| |
| if ( syntaxCheckerDescription == null ) |
| { |
| throw new ParseException( "Null", 0 ); |
| } |
| |
| reset( syntaxCheckerDescription ); // reset and initialize the parser / lexer pair |
| |
| try |
| { |
| SyntaxCheckerDescription syntaxChecker = parser.syntaxCheckerDescription(); |
| |
| // Update the schemaName |
| setSchemaName( syntaxChecker ); |
| |
| return syntaxChecker; |
| } |
| catch ( RecognitionException re ) |
| { |
| String msg = I18n.err( I18n.ERR_04259, syntaxCheckerDescription, re.getMessage(), re.getColumn() ); |
| LOG.error( msg ); |
| throw new ParseException( msg, re.getColumn() ); |
| } |
| catch ( TokenStreamException tse ) |
| { |
| String msg = I18n.err( I18n.ERR_04260, syntaxCheckerDescription, tse.getMessage() ); |
| LOG.error( msg ); |
| throw new ParseException( msg, 0 ); |
| } |
| |
| } |
| |
| |
| /** |
| * Parses a SyntaxChecker description |
| * |
| * @param schemaDescription The SyntaxChecker description to parse |
| * @return An instance of SyntaxCheckerDescription |
| */ |
| public SyntaxCheckerDescription parse( String schemaDescription ) throws ParseException |
| { |
| return parseSyntaxCheckerDescription( schemaDescription ); |
| } |
| } |