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 *    https://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.ObjectClass;
027
028
029/**
030 * A parser for RFC 4512 object class descriptons
031 * 
032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
033 */
034public class ObjectClassDescriptionSchemaParser extends AbstractSchemaParser<ObjectClass>
035{
036
037    /**
038     * Creates a schema parser instance.
039     */
040    public ObjectClassDescriptionSchemaParser()
041    {
042        super( ObjectClass.class, I18n.ERR_13857_CANNOT_PARSE_NULL_OC, I18n.ERR_13858_OC_PARSING_FAILURE, 
043            I18n.ERR_13859_OC_DESC_PARSING_FAILURE );
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 ObjectClass parse( String objectClassDescription ) throws ParseException
073    {
074        ObjectClass objectClass = fastParser.parseObjectClass( objectClassDescription );
075        objectClass.setSpecification( objectClassDescription );
076
077        // Update the schemaName
078        updateSchemaName( objectClass );
079
080        return objectClass;
081    }
082}