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.parsers; 021 022 023import java.text.ParseException; 024 025import org.apache.directory.api.i18n.I18n; 026import org.slf4j.Logger; 027import org.slf4j.LoggerFactory; 028 029import antlr.RecognitionException; 030import antlr.TokenStreamException; 031 032 033/** 034 * A parser for ApacheDS normalizer descriptions. 035 * 036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 037 */ 038public class NormalizerDescriptionSchemaParser extends AbstractSchemaParser 039{ 040 /** The LoggerFactory used by this class */ 041 protected static final Logger LOG = LoggerFactory.getLogger( NormalizerDescriptionSchemaParser.class ); 042 043 044 /** 045 * Creates a schema parser instance. 046 */ 047 public NormalizerDescriptionSchemaParser() 048 { 049 super(); 050 } 051 052 053 /** 054 * Parses a normalizer description: 055 * 056 * <pre> 057 * NormalizerDescription = LPAREN WSP 058 * numericoid ; object identifier 059 * [ SP "DESC" SP qdstring ] ; description 060 * SP "FQCN" SP fqcn ; fully qualified class name 061 * [ SP "BYTECODE" SP base64 ] ; optional base64 encoded bytecode 062 * extensions WSP RPAREN ; extensions 063 * 064 * base64 = *(4base64-char) 065 * base64-char = ALPHA / DIGIT / "+" / "/" 066 * fqcn = fqcnComponent 1*( DOT fqcnComponent ) 067 * fqcnComponent = ??? 068 * 069 * extensions = *( SP xstring SP qdstrings ) 070 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 071 * </pre> 072 * 073 * @param normalizerDescription the normalizer description to be parsed 074 * @return the parsed NormalizerDescription bean 075 * @throws ParseException if there are any recognition errors (bad syntax) 076 */ 077 public synchronized NormalizerDescription parseNormalizerDescription( String normalizerDescription ) 078 throws ParseException 079 { 080 LOG.debug( "Parsing a Normalizer : {}", normalizerDescription ); 081 082 if ( normalizerDescription == null ) 083 { 084 LOG.error( I18n.err( I18n.ERR_04251 ) ); 085 throw new ParseException( "Null", 0 ); 086 } 087 088 reset( normalizerDescription ); // reset and initialize the parser / lexer pair 089 090 try 091 { 092 NormalizerDescription normalizer = parser.normalizerDescription(); 093 094 // Update the schemaName 095 updateSchemaName( normalizer ); 096 097 return normalizer; 098 } 099 catch ( RecognitionException re ) 100 { 101 String msg = I18n.err( I18n.ERR_04252, normalizerDescription, re.getMessage(), re.getColumn() ); 102 LOG.error( msg ); 103 throw new ParseException( msg, re.getColumn() ); 104 } 105 catch ( TokenStreamException tse ) 106 { 107 String msg = I18n.err( I18n.ERR_04253, normalizerDescription, tse.getMessage() ); 108 LOG.error( msg ); 109 throw new ParseException( msg, 0 ); 110 } 111 112 } 113 114 115 /** 116 * Parses a Normalizer description. 117 * 118 * @param schemaDescription The Normalizer description to parse 119 * @return An instance of NormalizerDescription 120 * @throws ParseException {@inheritDoc} 121 */ 122 public NormalizerDescription parse( String schemaDescription ) throws ParseException 123 { 124 return parseNormalizerDescription( schemaDescription ); 125 } 126}