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 object class descriptons
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 * @version $Rev$, $Date$
035 */
036 public class ObjectClassDescriptionSchemaParser extends AbstractSchemaParser
037 {
038
039 /**
040 * Creates a schema parser instance.
041 */
042 public ObjectClassDescriptionSchemaParser()
043 {
044 }
045
046
047 /**
048 * Parses a object class definition according to RFC 4512:
049 *
050 * <pre>
051 * ObjectClassDescription = LPAREN WSP
052 * numericoid ; object identifier
053 * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
054 * [ SP "DESC" SP qdstring ] ; description
055 * [ SP "OBSOLETE" ] ; not active
056 * [ SP "SUP" SP oids ] ; superior object classes
057 * [ SP kind ] ; kind of class
058 * [ SP "MUST" SP oids ] ; attribute types
059 * [ SP "MAY" SP oids ] ; attribute types
060 * extensions WSP RPAREN
061 *
062 * kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
063 *
064 * extensions = *( SP xstring SP qdstrings )
065 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
066 * </pre>
067 *
068 * @param objectClassDescription the object class description to be parsed
069 * @return the parsed ObjectClassDescription bean
070 * @throws ParseException if there are any recognition errors (bad syntax)
071 */
072 public synchronized ObjectClassDescription parseObjectClassDescription( String objectClassDescription )
073 throws ParseException
074 {
075
076 if ( objectClassDescription == null )
077 {
078 throw new ParseException( "Null", 0 );
079 }
080
081 reset( objectClassDescription ); // reset and initialize the parser / lexer pair
082
083 try
084 {
085 ObjectClassDescription ocd = parser.objectClassDescription();
086 return ocd;
087 }
088 catch ( RecognitionException re )
089 {
090 String msg = "Parser failure on object class description:\n\t" + objectClassDescription;
091 msg += "\nAntlr message: " + re.getMessage();
092 msg += "\nAntlr column: " + re.getColumn();
093 throw new ParseException( msg, re.getColumn() );
094 }
095 catch ( TokenStreamException tse )
096 {
097 String msg = "Parser failure on object class description:\n\t" + objectClassDescription;
098 msg += "\nAntlr message: " + tse.getMessage();
099 throw new ParseException( msg, 0 );
100 }
101
102 }
103
104
105 public AbstractSchemaDescription parse( String schemaDescription ) throws ParseException
106 {
107 return parseObjectClassDescription( schemaDescription );
108 }
109
110 }