001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.directory.api.ldap.model.schema.syntaxCheckers; 021 022 023import java.text.ParseException; 024 025import org.apache.directory.api.ldap.model.constants.SchemaConstants; 026import org.apache.directory.api.ldap.model.schema.SyntaxChecker; 027import org.apache.directory.api.ldap.model.schema.parsers.MatchingRuleDescriptionSchemaParser; 028import org.apache.directory.api.util.Strings; 029import org.slf4j.Logger; 030import org.slf4j.LoggerFactory; 031 032 033/** 034 * A SyntaxChecker which verifies that a value follows the 035 * matching rule descripton syntax according to RFC 4512, par 4.2.3: 036 * 037 * <pre> 038 * MatchingRuleDescription = LPAREN WSP 039 * numericoid ; object identifier 040 * [ SP "NAME" SP qdescrs ] ; short names (descriptors) 041 * [ SP "DESC" SP qdstring ] ; description 042 * [ SP "OBSOLETE" ] ; not active 043 * SP "SYNTAX" SP numericoid ; assertion syntax 044 * extensions WSP RPAREN ; extensions 045 * 046 * extensions = *( SP xstring SP qdstrings ) 047 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 048 * 049 * </pre> 050 * 051 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 052 */ 053@SuppressWarnings("serial") 054public class MatchingRuleDescriptionSyntaxChecker extends SyntaxChecker 055{ 056 /** A logger for this class */ 057 private static final Logger LOG = LoggerFactory.getLogger( MatchingRuleDescriptionSyntaxChecker.class ); 058 059 /** The schema parser used to parse the MatchingRuleDescription Syntax */ 060 private MatchingRuleDescriptionSchemaParser schemaParser = new MatchingRuleDescriptionSchemaParser(); 061 062 063 /** 064 * 065 * Creates a new instance of MatchingRuleDescriptionSchemaParser. 066 * 067 */ 068 public MatchingRuleDescriptionSyntaxChecker() 069 { 070 super( SchemaConstants.MATCHING_RULE_DESCRIPTION_SYNTAX ); 071 } 072 073 074 /** 075 * {@inheritDoc} 076 */ 077 public boolean isValidSyntax( Object value ) 078 { 079 String strValue = null; 080 081 if ( value == null ) 082 { 083 LOG.debug( "Syntax invalid for 'null'" ); 084 return false; 085 } 086 087 if ( value instanceof String ) 088 { 089 strValue = ( String ) value; 090 } 091 else if ( value instanceof byte[] ) 092 { 093 strValue = Strings.utf8ToString( ( byte[] ) value ); 094 } 095 else 096 { 097 strValue = value.toString(); 098 } 099 100 try 101 { 102 schemaParser.parseMatchingRuleDescription( strValue ); 103 LOG.debug( "Syntax valid for '{}'", value ); 104 105 return true; 106 } 107 catch ( ParseException pe ) 108 { 109 LOG.debug( "Syntax invalid for '{}'", value ); 110 return false; 111 } 112 } 113 114}