org.apache.directory.api.ldap.model.schema.parsers.ObjectClassDescriptionSchemaParser Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.directory.api.ldap.model.schema.parsers;
import java.text.ParseException;
import org.apache.directory.api.i18n.I18n;
import org.apache.directory.api.ldap.model.schema.ObjectClass;
/**
* A parser for RFC 4512 object class descriptons
*
* @author Apache Directory Project
*/
public class ObjectClassDescriptionSchemaParser extends AbstractSchemaParser
{
/**
* Creates a schema parser instance.
*/
public ObjectClassDescriptionSchemaParser()
{
super( ObjectClass.class, I18n.ERR_13407_CANNOT_PARSE_NULL_OC, I18n.ERR_13408_OC_PARSING_FAILURE, I18n.ERR_13409_OC_DESC_PARSING_FAILURE );
}
/**
* Parses a object class definition according to RFC 4512:
*
*
* ObjectClassDescription = LPAREN WSP
* numericoid ; object identifier
* [ SP "NAME" SP qdescrs ] ; short names (descriptors)
* [ SP "DESC" SP qdstring ] ; description
* [ SP "OBSOLETE" ] ; not active
* [ SP "SUP" SP oids ] ; superior object classes
* [ SP kind ] ; kind of class
* [ SP "MUST" SP oids ] ; attribute types
* [ SP "MAY" SP oids ] ; attribute types
* extensions WSP RPAREN
*
* kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
*
* extensions = *( SP xstring SP qdstrings )
* xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
*
*
* @param objectClassDescription the object class description to be parsed
* @return the parsed ObjectClassDescription bean
* @throws ParseException if there are any recognition errors (bad syntax)
*/
public ObjectClass parse( String objectClassDescription ) throws ParseException
{
ObjectClass objectClass = fastParser.parseObjectClass( objectClassDescription );
objectClass.setSpecification( objectClassDescription );
// Update the schemaName
updateSchemaName( objectClass );
return objectClass;
}
}