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.apache.directory.api.ldap.model.schema.MutableObjectClass; 027import org.apache.directory.api.ldap.model.schema.ObjectClass; 028import org.slf4j.Logger; 029import org.slf4j.LoggerFactory; 030 031import antlr.RecognitionException; 032import antlr.TokenStreamException; 033 034 035/** 036 * A parser for RFC 4512 object class descriptons 037 * 038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 039 */ 040public class ObjectClassDescriptionSchemaParser extends AbstractSchemaParser 041{ 042 /** The LoggerFactory used by this class */ 043 protected static final Logger LOG = LoggerFactory.getLogger( ObjectClassDescriptionSchemaParser.class ); 044 045 046 /** 047 * Creates a schema parser instance. 048 */ 049 public ObjectClassDescriptionSchemaParser() 050 { 051 // Nothing to do 052 } 053 054 055 /** 056 * Parses a object class definition according to RFC 4512: 057 * 058 * <pre> 059 * ObjectClassDescription = LPAREN WSP 060 * numericoid ; object identifier 061 * [ SP "NAME" SP qdescrs ] ; short names (descriptors) 062 * [ SP "DESC" SP qdstring ] ; description 063 * [ SP "OBSOLETE" ] ; not active 064 * [ SP "SUP" SP oids ] ; superior object classes 065 * [ SP kind ] ; kind of class 066 * [ SP "MUST" SP oids ] ; attribute types 067 * [ SP "MAY" SP oids ] ; attribute types 068 * extensions WSP RPAREN 069 * 070 * kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY" 071 * 072 * extensions = *( SP xstring SP qdstrings ) 073 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 074 * </pre> 075 * 076 * @param objectClassDescription the object class description to be parsed 077 * @return the parsed ObjectClassDescription bean 078 * @throws ParseException if there are any recognition errors (bad syntax) 079 */ 080 public synchronized MutableObjectClass parseObjectClassDescription( String objectClassDescription ) 081 throws ParseException 082 { 083 LOG.debug( "Parsing an ObjectClass : {}", objectClassDescription ); 084 085 if ( objectClassDescription == null ) 086 { 087 LOG.error( I18n.err( I18n.ERR_04254 ) ); 088 throw new ParseException( "Null", 0 ); 089 } 090 091 reset( objectClassDescription ); // reset and initialize the parser / lexer pair 092 093 try 094 { 095 MutableObjectClass objectClass = parser.objectClassDescription(); 096 097 // Update the schemaName 098 updateSchemaName( objectClass ); 099 100 return objectClass; 101 } 102 catch ( RecognitionException re ) 103 { 104 String msg = I18n.err( I18n.ERR_04255, objectClassDescription, re.getMessage(), re.getColumn() ); 105 LOG.error( msg ); 106 throw new ParseException( msg, re.getColumn() ); 107 } 108 catch ( TokenStreamException tse ) 109 { 110 String msg = I18n.err( I18n.ERR_04256, objectClassDescription, tse.getMessage() ); 111 LOG.error( msg ); 112 throw new ParseException( msg, 0 ); 113 } 114 115 } 116 117 118 /** 119 * Parses a ObjectClass description. 120 * 121 * @param schemaDescription The ObjectClass description to parse 122 * @return An instance of ObjectClass 123 * @throws ParseException {@inheritDoc} 124 */ 125 public ObjectClass parse( String schemaDescription ) throws ParseException 126 { 127 return parseObjectClassDescription( schemaDescription ); 128 } 129 130}