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.AttributeType;
27
28
29 /**
30 * A parser for RFC 4512 attribute type descriptions.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public class AttributeTypeDescriptionSchemaParser extends AbstractSchemaParser<AttributeType>
35 {
36 /**
37 * Creates a schema parser instance.
38 */
39 public AttributeTypeDescriptionSchemaParser()
40 {
41 super( AttributeType.class, I18n.ERR_13830_CANNOT_PARSE_NULL_ATTR_TYPE, I18n.ERR_13831_ATTRIBUTE_TYPE_PARSING_FAILURE,
42 I18n.ERR_13832_ATTRIBUTE_TYPE_DESC_PARSE_FAILURE );
43 }
44
45
46 /**
47 * Parses a attribute type description according to RFC 4512:
48 *
49 * <pre>
50 * AttributeTypeDescription = LPAREN WSP
51 * numericoid ; object identifier
52 * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
53 * [ SP "DESC" SP qdstring ] ; description
54 * [ SP "OBSOLETE" ] ; not active
55 * [ SP "SUP" SP oid ] ; supertype
56 * [ SP "EQUALITY" SP oid ] ; equality matching rule
57 * [ SP "ORDERING" SP oid ] ; ordering matching rule
58 * [ SP "SUBSTR" SP oid ] ; substrings matching rule
59 * [ SP "SYNTAX" SP noidlen ] ; value syntax
60 * [ SP "SINGLE-VALUE" ] ; single-value
61 * [ SP "COLLECTIVE" ] ; collective
62 * [ SP "NO-USER-MODIFICATION" ] ; not user modifiable
63 * [ SP "USAGE" SP usage ] ; usage
64 * extensions WSP RPAREN ; extensions
65 *
66 * usage = "userApplications" / ; user
67 * "directoryOperation" / ; directory operational
68 * "distributedOperation" / ; DSA-shared operational
69 * "dSAOperation" ; DSA-specific operational
70 *
71 * extensions = *( SP xstring SP qdstrings )
72 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
73 * </pre>
74 *
75 * @param attributeTypeDescription the attribute type description to be parsed
76 * @return the parsed AttributeTypeDescription bean
77 * @throws ParseException if there are any recognition errors (bad syntax)
78 */
79 public AttributeType parse( String attributeTypeDescription ) throws ParseException
80 {
81 AttributeType attributeType = fastParser.parseAttributeType( attributeTypeDescription );
82 attributeType.setSpecification( attributeTypeDescription );
83
84 // Update the schemaName
85 updateSchemaName( attributeType );
86
87 return attributeType;
88 }
89 }