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
026 import antlr.RecognitionException;
027 import antlr.TokenStreamException;
028
029
030 /**
031 * A parser for RFC 4512 LDAP syntx descriptions.
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 * @version $Rev$, $Date$
035 */
036 public class LdapSyntaxDescriptionSchemaParser extends AbstractSchemaParser
037 {
038
039 /**
040 * Creates a schema parser instance.
041 */
042 public LdapSyntaxDescriptionSchemaParser()
043 {
044 }
045
046
047 /**
048 * Parses a LDAP syntax description according to RFC 4512:
049 *
050 * <pre>
051 * SyntaxDescription = LPAREN WSP
052 * numericoid ; object identifier
053 * [ SP "DESC" SP qdstring ] ; description
054 * extensions WSP RPAREN ; extensions
055 * </pre>
056 *
057 * @param ldapSyntaxDescription the LDAP syntay description to be parsed
058 * @return the parsed LdapSyntaxDescription bean
059 * @throws ParseException if there are any recognition errors (bad syntax)
060 */
061 public synchronized LdapSyntaxDescription parseLdapSyntaxDescription( String ldapSyntaxDescription )
062 throws ParseException
063 {
064
065 if ( ldapSyntaxDescription == null )
066 {
067 throw new ParseException( "Null", 0 );
068 }
069
070 reset( ldapSyntaxDescription ); // reset and initialize the parser / lexer pair
071
072 try
073 {
074 LdapSyntaxDescription lsd = parser.ldapSyntaxDescription();
075 return lsd;
076 }
077 catch ( RecognitionException re )
078 {
079 String msg = "Parser failure on LDAP syntay description:\n\t" + ldapSyntaxDescription;
080 msg += "\nAntlr message: " + re.getMessage();
081 msg += "\nAntlr column: " + re.getColumn();
082 throw new ParseException( msg, re.getColumn() );
083 }
084 catch ( TokenStreamException tse )
085 {
086 String msg = "Parser failure on LDAP syntay description:\n\t" + ldapSyntaxDescription;
087 msg += "\nAntlr message: " + tse.getMessage();
088 throw new ParseException( msg, 0 );
089 }
090
091 }
092
093
094 public AbstractSchemaDescription parse( String schemaDescription ) throws ParseException
095 {
096 return parseLdapSyntaxDescription( schemaDescription );
097 }
098
099 }