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.MatchingRuleUse; 27 28 29 /** 30 * A parser for RFC 4512 matching rule use descriptions. 31 * 32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 33 */ 34 public class MatchingRuleUseDescriptionSchemaParser extends AbstractSchemaParser<MatchingRuleUse> 35 { 36 37 /** 38 * Creates a schema parser instance. 39 */ 40 public MatchingRuleUseDescriptionSchemaParser() 41 { 42 super( MatchingRuleUse.class, I18n.ERR_13848_CANNOT_PARSE_NULL_MRU, I18n.ERR_13849_MRU_PARSING_FAILURE, 43 I18n.ERR_13850_MRU_DESC_PARSING_FAILURE ); 44 } 45 46 47 /** 48 * Parses a matching rule use description according to RFC 4512: 49 * 50 * <pre> 51 * MatchingRuleUseDescription = 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 "APPLIES" SP oids ; attribute types 57 * extensions WSP RPAREN ; extensions 58 * 59 * extensions = *( SP xstring SP qdstrings ) 60 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 61 * </pre> 62 * 63 * @param matchingRuleUseDescription the matching rule use description to be parsed 64 * @return the parsed MatchingRuleUseDescription bean 65 * @throws ParseException if there are any recognition errors (bad syntax) 66 */ 67 public MatchingRuleUse parse( String matchingRuleUseDescription ) throws ParseException 68 { 69 MatchingRuleUse matchingRuleUse = fastParser.parseMatchingRuleUse( matchingRuleUseDescription ); 70 matchingRuleUse.setSpecification( matchingRuleUseDescription ); 71 72 // Update the schemaName 73 updateSchemaName( matchingRuleUse ); 74 75 return matchingRuleUse; 76 } 77 }