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  import org.apache.directory.api.ldap.model.schema.NameForm;
27  
28  
29  /**
30   * A parser for RFC 4512 name form descriptions
31   * 
32   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33   */
34  public class NameFormDescriptionSchemaParser extends AbstractSchemaParser<NameForm>
35  {
36  
37      /**
38       * Creates a schema parser instance.
39       */
40      public NameFormDescriptionSchemaParser()
41      {
42          super( NameForm.class, I18n.ERR_13851_CANNOT_PARSE_NULL_NF, I18n.ERR_13852_NF_PARSING_FAILURE, 
43              I18n.ERR_13853_NF_DESC_PARSING_FAILURE );
44      }
45  
46  
47      /**
48       * Parses a name form description according to RFC 4512:
49       * 
50       * <pre>
51       * NameFormDescription = LPAREN WSP
52       *    numericoid                 ; object identifier
53       *    [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
54       *    [ SP "DESC" SP qdstring ]  ; description
55       *    [ SP "OBSOLETE" ]          ; not active
56       *    SP "OC" SP oid             ; structural object class
57       *    SP "MUST" SP oids          ; attribute types
58       *    [ SP "MAY" SP oids ]       ; attribute types
59       *    extensions WSP RPAREN      ; extensions
60       * </pre>
61       * 
62       * @param nameFormDescription the name form description to be parsed
63       * @return the parsed NameForm bean
64       * @throws ParseException if there are any recognition errors (bad syntax)
65       */
66      public NameForm parse( String nameFormDescription ) throws ParseException
67      {
68          NameForm nameForm = fastParser.parseNameForm( nameFormDescription );
69          nameForm.setSpecification( nameFormDescription );
70  
71          // Update the schemaName
72          updateSchemaName( nameForm );
73  
74          return nameForm;
75      }
76  }