View Javadoc
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 normalizer descriptions.
30   * 
31   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32   */
33  public class NormalizerDescriptionSchemaParser extends AbstractSchemaParser<NormalizerDescription>
34  {
35  
36      /**
37       * Creates a schema parser instance.
38       */
39      public NormalizerDescriptionSchemaParser()
40      {
41          super( NormalizerDescription.class, I18n.ERR_13854_CANNOT_PARSE_NULL_NORM, I18n.ERR_13855_NORM_PARSING_FAILURE,
42              I18n.ERR_13856_NORM_DESC_PARSING_FAILURE );
43      }
44  
45  
46      /**
47       * Parses a normalizer description:
48       * 
49       * <pre>
50       * NormalizerDescription = 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 normalizerDescription the normalizer description to be parsed
67       * @return the parsed NormalizerDescription bean
68       * @throws ParseException if there are any recognition errors (bad syntax)
69       */
70      public NormalizerDescription parse( String normalizerDescription ) throws ParseException
71      {
72          NormalizerDescription normalizer = fastParser.parseNormalizer( normalizerDescription );
73          normalizer.setSpecification( normalizerDescription );
74  
75          // Update the schemaName
76          updateSchemaName( normalizer );
77  
78          return normalizer;
79      }
80  }