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.shared.ldap.model.schema.syntaxCheckers; 021 022 023import java.text.ParseException; 024 025import org.apache.directory.shared.ldap.model.constants.SchemaConstants; 026import org.apache.directory.shared.ldap.model.schema.SyntaxChecker; 027import org.apache.directory.shared.ldap.model.schema.parsers.DITContentRuleDescriptionSchemaParser; 028import org.apache.directory.shared.util.Strings; 029import org.slf4j.Logger; 030import org.slf4j.LoggerFactory; 031 032 033/** 034 * A SyntaxChecker which verifies that a value follows the 035 * DIT content rule descripton syntax according to RFC 4512, par 4.2.6: 036 * 037 * <pre> 038 * DITContentRuleDescription = 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 "AUX" SP oids ] ; auxiliary object classes 044 * [ SP "MUST" SP oids ] ; attribute types 045 * [ SP "MAY" SP oids ] ; attribute types 046 * [ SP "NOT" SP oids ] ; attribute types 047 * extensions WSP RPAREN ; extensions 048 * </pre> 049 * 050 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 051 */ 052@SuppressWarnings("serial") 053public class DITContentRuleDescriptionSyntaxChecker extends SyntaxChecker 054{ 055 /** A logger for this class */ 056 private static final Logger LOG = LoggerFactory.getLogger( DITContentRuleDescriptionSyntaxChecker.class ); 057 058 /** The schema parser used to parse the DITContentRuleDescription Syntax */ 059 private DITContentRuleDescriptionSchemaParser schemaParser = new DITContentRuleDescriptionSchemaParser(); 060 061 062 /** 063 * Creates a new instance of DITContentRuleDescriptionSyntaxChecker. 064 */ 065 public DITContentRuleDescriptionSyntaxChecker() 066 { 067 super( SchemaConstants.DIT_CONTENT_RULE_SYNTAX ); 068 } 069 070 071 /** 072 * {@inheritDoc} 073 */ 074 public boolean isValidSyntax( Object value ) 075 { 076 String strValue = null; 077 078 if ( value == null ) 079 { 080 LOG.debug( "Syntax invalid for 'null'" ); 081 return false; 082 } 083 084 if ( value instanceof String ) 085 { 086 strValue = ( String ) value; 087 } 088 else if ( value instanceof byte[] ) 089 { 090 strValue = Strings.utf8ToString((byte[]) value); 091 } 092 else 093 { 094 strValue = value.toString(); 095 } 096 097 try 098 { 099 schemaParser.parseDITContentRuleDescription( strValue ); 100 LOG.debug( "Syntax valid for '{}'", value ); 101 return true; 102 } 103 catch ( ParseException pe ) 104 { 105 LOG.debug( "Syntax invalid for '{}'", value ); 106 return false; 107 } 108 } 109}