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.DitStructureRule;
27
28
29 /**
30 * A parser for RFC 4512 DIT structure rule descriptions.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public class DitStructureRuleDescriptionSchemaParser extends AbstractSchemaParser<DitStructureRule>
35 {
36
37 /**
38 * Creates a schema parser instance.
39 */
40 public DitStructureRuleDescriptionSchemaParser()
41 {
42 super( DitStructureRule.class, I18n.ERR_13836_CANNOT_PARSE_NULL_DSR, I18n.ERR_13837_DSR_PARSING_FAILURE,
43 I18n.ERR_13838_DSR_DESC_PARSING_FAILURE );
44 }
45
46
47 /**
48 * Parses a DIT structure rule description according to RFC 4512:
49 *
50 * <pre>
51 * DITStructureRuleDescription = LPAREN WSP
52 * ruleid ; rule identifier
53 * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
54 * [ SP "DESC" SP qdstring ] ; description
55 * [ SP "OBSOLETE" ] ; not active
56 * SP "FORM" SP oid ; NameForm
57 * [ SP "SUP" ruleids ] ; superior rules
58 * extensions WSP RPAREN ; extensions
59 *
60 * ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN )
61 * ruleidlist = ruleid *( SP ruleid )
62 * ruleid = numbers
63 * </pre>
64 *
65 * @param ditStructureRuleDescription the DIT structure rule description to be parsed
66 * @return the parsed DITStructureRuleDescription bean
67 * @throws ParseException if there are any recognition errors (bad syntax)
68 */
69 public DitStructureRule parse( String ditStructureRuleDescription ) throws ParseException
70 {
71 DitStructureRule ditStructureRule = fastParser.parseDitStructureRule( ditStructureRuleDescription );
72 ditStructureRule.setSpecification( ditStructureRuleDescription );
73
74 // Update the schemaName
75 updateSchemaName( ditStructureRule );
76
77 return ditStructureRule;
78 }
79 }