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
27
28 /**
29 * A parser for ApacheDS syntax checker descriptions.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public class SyntaxCheckerDescriptionSchemaParser extends AbstractSchemaParser<SyntaxCheckerDescription>
34 {
35
36 /**
37 * Creates a schema parser instance.
38 */
39 public SyntaxCheckerDescriptionSchemaParser()
40 {
41 super( SyntaxCheckerDescription.class, I18n.ERR_13860_CANNOT_PARSE_NULL_SC, I18n.ERR_13861_SC_PARSING_FAILURE,
42 I18n.ERR_13862_SC_PARSING_FAILURE );
43 }
44
45
46 /**
47 * Parses a syntax checker description:
48 *
49 * <pre>
50 * SyntaxCheckerDescription = LPAREN WSP
51 * numericoid ; object identifier
52 * [ SP "DESC" SP qdstring ] ; description
53 * SP "FQCN" SP fqcn ; fully qualified class name
54 * [ SP "BYTECODE" SP base64 ] ; optional base64 encoded bytecode
55 * extensions WSP RPAREN ; extensions
56 *
57 * base64 = *(4base64-char)
58 * base64-char = ALPHA / DIGIT / "+" / "/"
59 * fqcn = fqcnComponent 1*( DOT fqcnComponent )
60 * fqcnComponent = ???
61 *
62 * extensions = *( SP xstring SP qdstrings )
63 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
64 * </pre>
65 *
66 * @param syntaxCheckerDescription the syntax checker description to be parsed
67 * @return the parsed SyntaxCheckerDescription bean
68 * @throws ParseException if there are any recognition errors (bad syntax)
69 */
70 public SyntaxCheckerDescription parse( String syntaxCheckerDescription ) throws ParseException
71 {
72 SyntaxCheckerDescription syntaxChecker = fastParser.parseSyntaxChecker( syntaxCheckerDescription );
73 syntaxChecker.setSpecification( syntaxCheckerDescription );
74
75 // Update the schemaName
76 updateSchemaName( syntaxChecker );
77
78 return syntaxChecker;
79 }
80 }