1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.model.schema.parsers;
21
22
23 import java.text.ParseException;
24
25 import org.apache.directory.api.i18n.I18n;
26 import org.apache.directory.api.ldap.model.schema.ObjectClass;
27
28
29 /**
30 * A parser for RFC 4512 object class descriptons
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public class ObjectClassDescriptionSchemaParser extends AbstractSchemaParser<ObjectClass>
35 {
36
37 /**
38 * Creates a schema parser instance.
39 */
40 public ObjectClassDescriptionSchemaParser()
41 {
42 super( ObjectClass.class, I18n.ERR_13857_CANNOT_PARSE_NULL_OC, I18n.ERR_13858_OC_PARSING_FAILURE,
43 I18n.ERR_13859_OC_DESC_PARSING_FAILURE );
44 }
45
46
47 /**
48 * Parses a object class definition according to RFC 4512:
49 *
50 * <pre>
51 * ObjectClassDescription = LPAREN WSP
52 * numericoid ; object identifier
53 * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
54 * [ SP "DESC" SP qdstring ] ; description
55 * [ SP "OBSOLETE" ] ; not active
56 * [ SP "SUP" SP oids ] ; superior object classes
57 * [ SP kind ] ; kind of class
58 * [ SP "MUST" SP oids ] ; attribute types
59 * [ SP "MAY" SP oids ] ; attribute types
60 * extensions WSP RPAREN
61 *
62 * kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
63 *
64 * extensions = *( SP xstring SP qdstrings )
65 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
66 * </pre>
67 *
68 * @param objectClassDescription the object class description to be parsed
69 * @return the parsed ObjectClassDescription bean
70 * @throws ParseException if there are any recognition errors (bad syntax)
71 */
72 public ObjectClass parse( String objectClassDescription ) throws ParseException
73 {
74 ObjectClass objectClass = fastParser.parseObjectClass( objectClassDescription );
75 objectClass.setSpecification( objectClassDescription );
76
77 // Update the schemaName
78 updateSchemaName( objectClass );
79
80 return objectClass;
81 }
82 }