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.MatchingRule;
27
28
29 /**
30 * A parser for RFC 4512 matching rule descriptions.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public class MatchingRuleDescriptionSchemaParser extends AbstractSchemaParser<MatchingRule>
35 {
36 /**
37 * Creates a schema parser instance.
38 */
39 public MatchingRuleDescriptionSchemaParser()
40 {
41 super( MatchingRule.class, I18n.ERR_13845_CANNOT_PARSE_NULL_MR, I18n.ERR_13846_MR_PARSING_FAILURE,
42 I18n.ERR_13847_MR_DESC_PARSING_FAILURE );
43 }
44
45
46 /**
47 * Parses a matching rule description according to RFC 4512:
48 *
49 * <pre>
50 * MatchingRuleDescription = LPAREN WSP
51 * numericoid ; object identifier
52 * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
53 * [ SP "DESC" SP qdstring ] ; description
54 * [ SP "OBSOLETE" ] ; not active
55 * SP "SYNTAX" SP numericoid ; assertion syntax
56 * extensions WSP RPAREN ; extensions
57 *
58 * extensions = *( SP xstring SP qdstrings )
59 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
60 * </pre>
61 *
62 * @param matchingRuleDescription the matching rule description to be parsed
63 * @return the parsed MatchingRuleDescription bean
64 * @throws ParseException if there are any recognition errors (bad syntax)
65 */
66 public MatchingRule parse( String matchingRuleDescription ) throws ParseException
67 {
68 MatchingRule matchingRule = fastParser.parseMatchingRule( matchingRuleDescription );
69 matchingRule.setSpecification( matchingRuleDescription );
70
71 // Update the schemaName
72 updateSchemaName( matchingRule );
73
74 return matchingRule;
75 }
76 }