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 * http://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.slf4j.Logger;
27 import org.slf4j.LoggerFactory;
28
29 import antlr.RecognitionException;
30 import antlr.TokenStreamException;
31
32
33 /**
34 * A parser for ApacheDS comparator descriptions.
35 *
36 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
37 */
38 public class LdapComparatorDescriptionSchemaParser extends AbstractSchemaParser
39 {
40 /** The LoggerFactory used by this class */
41 protected static final Logger LOG = LoggerFactory.getLogger( LdapComparatorDescriptionSchemaParser.class );
42
43
44 /**
45 * Creates a schema parser instance.
46 */
47 public LdapComparatorDescriptionSchemaParser()
48 {
49 super();
50 }
51
52
53 /**
54 * Parses an comparator description:
55 *
56 * <pre>
57 * ComparatorDescription = LPAREN WSP
58 * numericoid ; object identifier
59 * [ SP "DESC" SP qdstring ] ; description
60 * SP "FQCN" SP fqcn ; fully qualified class name
61 * [ SP "BYTECODE" SP base64 ] ; optional base64 encoded bytecode
62 * extensions WSP RPAREN ; extensions
63 *
64 * base64 = *(4base64-char)
65 * base64-char = ALPHA / DIGIT / "+" / "/"
66 * fqcn = fqcnComponent 1*( DOT fqcnComponent )
67 * fqcnComponent = ???
68 *
69 * extensions = *( SP xstring SP qdstrings )
70 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
71 * </pre>
72 *
73 * @param comparatorDescription the comparator description to be parsed
74 * @return the parsed ComparatorDescription bean
75 * @throws ParseException if there are any recognition errors (bad syntax)
76 */
77 public LdapComparatorDescription parseComparatorDescription( String comparatorDescription )
78 throws ParseException
79 {
80 LOG.debug( "Parsing a Comparator : {}", comparatorDescription );
81
82 if ( comparatorDescription == null )
83 {
84 LOG.error( I18n.err( I18n.ERR_04236 ) );
85 throw new ParseException( "Null", 0 );
86 }
87
88 synchronized ( parser )
89 {
90 reset( comparatorDescription ); // reset and initialize the parser / lexer pair
91
92 try
93 {
94 LdapComparatorDescription ldapComparatorDescription = parser.ldapComparator();
95 LOG.debug( "Parsed a LdapComparator : {}", ldapComparatorDescription );
96
97 // Update the schemaName
98 updateSchemaName( ldapComparatorDescription );
99
100 return ldapComparatorDescription;
101 }
102 catch ( RecognitionException re )
103 {
104 String msg = I18n.err( I18n.ERR_04273, comparatorDescription, re.getMessage(), re.getColumn() );
105 LOG.error( msg );
106 throw new ParseException( msg, re.getColumn() );
107 }
108 catch ( TokenStreamException tse )
109 {
110 String msg = I18n.err( I18n.ERR_04238, comparatorDescription, tse.getMessage() );
111 LOG.error( msg );
112 throw new ParseException( msg, 0 );
113 }
114 }
115 }
116
117
118 /**
119 * Parses a LdapComparator description.
120 *
121 * @param schemaDescription The LdapComparator description to parse
122 * @return An instance of LdapComparatorDescription
123 * @throws ParseException {@inheritDoc}
124 */
125 public LdapComparatorDescription parse( String schemaDescription ) throws ParseException
126 {
127 return parseComparatorDescription( schemaDescription );
128 }
129 }