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 */ 020 package org.apache.directory.shared.ldap.schema.syntaxCheckers; 021 022 023 import java.text.ParseException; 024 025 import org.apache.directory.shared.ldap.constants.SchemaConstants; 026 import org.apache.directory.shared.ldap.schema.SyntaxChecker; 027 import org.apache.directory.shared.ldap.schema.parsers.DITContentRuleDescriptionSchemaParser; 028 import org.apache.directory.shared.ldap.util.StringTools; 029 import org.slf4j.Logger; 030 import 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 * @version $Rev$ 052 */ 053 public class DITContentRuleDescriptionSyntaxChecker extends SyntaxChecker 054 { 055 /** A logger for this class */ 056 private static final Logger LOG = LoggerFactory.getLogger( DITContentRuleDescriptionSyntaxChecker.class ); 057 058 /** The serialVersionUID */ 059 private static final long serialVersionUID = 1L; 060 061 /** The schema parser used to parse the DITContentRuleDescription Syntax */ 062 private DITContentRuleDescriptionSchemaParser schemaParser = new DITContentRuleDescriptionSchemaParser(); 063 064 065 /** 066 * Creates a new instance of DITContentRuleDescriptionSyntaxChecker. 067 */ 068 public DITContentRuleDescriptionSyntaxChecker() 069 { 070 super( SchemaConstants.DIT_CONTENT_RULE_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 '{}'", value ); 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 = StringTools.utf8ToString( ( byte[] ) value ); 094 } 095 else 096 { 097 strValue = value.toString(); 098 } 099 100 try 101 { 102 schemaParser.parseDITContentRuleDescription( strValue ); 103 LOG.debug( "Syntax valid for '{}'", value ); 104 return true; 105 } 106 catch ( ParseException pe ) 107 { 108 LOG.debug( "Syntax invalid for '{}'", value ); 109 return false; 110 } 111 } 112 }