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.LdapSyntax;
27
28
29 /**
30 * A parser for RFC 4512 LDAP syntx descriptions.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public class LdapSyntaxDescriptionSchemaParser extends AbstractSchemaParser<LdapSyntax>
35 {
36
37 /**
38 * Creates a schema parser instance.
39 */
40 public LdapSyntaxDescriptionSchemaParser()
41 {
42 super( LdapSyntax.class, I18n.ERR_13842_CANNOT_PARSE_NULL_SYNTAX, I18n.ERR_13843_SYNTAX_PARSING_FAILURE,
43 I18n.ERR_13844_SYNTAX_DESC_PARSING_FAILURE );
44 }
45
46
47 /**
48 * Parses a LDAP syntax description according to RFC 4512:
49 *
50 * <pre>
51 * SyntaxDescription = LPAREN WSP
52 * numericoid ; object identifier
53 * [ SP "DESC" SP qdstring ] ; description
54 * extensions WSP RPAREN ; extensions
55 * </pre>
56 *
57 * @param ldapSyntaxDescription the LDAP syntax description to be parsed
58 * @return the parsed LdapSyntax bean
59 * @throws ParseException if there are any recognition errors (bad syntax)
60 */
61 public LdapSyntax parse( String ldapSyntaxDescription ) throws ParseException
62 {
63 LdapSyntax ldapSyntax = fastParser.parseLdapSyntax( ldapSyntaxDescription );
64 ldapSyntax.setSpecification( ldapSyntaxDescription );
65
66 // Update the schemaName
67 updateSchemaName( ldapSyntax );
68
69 return ldapSyntax;
70 }
71 }