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.ObjectClassDescriptionSchemaParser; 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 * object class descripton syntax according to RFC 4512, par 4.2.1: 036 * 037 * <pre> 038 * ObjectClassDescription = 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 "SUP" SP oids ] ; superior object classes 044 * [ SP kind ] ; kind of class 045 * [ SP "MUST" SP oids ] ; attribute types 046 * [ SP "MAY" SP oids ] ; attribute types 047 * extensions WSP RPAREN 048 * 049 * kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY" 050 * 051 * extensions = *( SP xstring SP qdstrings ) 052 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 053 * </pre> 054 * 055 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 056 */ 057@SuppressWarnings("serial") 058public class ObjectClassDescriptionSyntaxChecker extends SyntaxChecker 059{ 060 /** A logger for this class */ 061 private static final Logger LOG = LoggerFactory.getLogger( ObjectClassDescriptionSyntaxChecker.class ); 062 063 /** The schema parser used to parse the ObjectClassDescription Syntax */ 064 private ObjectClassDescriptionSchemaParser schemaParser = new ObjectClassDescriptionSchemaParser(); 065 066 067 /** 068 * Creates a new instance of ObjectClassDescriptionSyntaxChecker. 069 */ 070 public ObjectClassDescriptionSyntaxChecker() 071 { 072 super( SchemaConstants.OBJECT_CLASS_DESCRIPTION_SYNTAX ); 073 } 074 075 076 /** 077 * {@inheritDoc} 078 */ 079 public boolean isValidSyntax( Object value ) 080 { 081 String strValue = null; 082 083 if ( value == null ) 084 { 085 LOG.debug( "Syntax invalid for 'null'" ); 086 return false; 087 } 088 089 if ( value instanceof String ) 090 { 091 strValue = ( String ) value; 092 } 093 else if ( value instanceof byte[] ) 094 { 095 strValue = Strings.utf8ToString( ( byte[] ) value ); 096 } 097 else 098 { 099 strValue = value.toString(); 100 } 101 102 try 103 { 104 schemaParser.parseObjectClassDescription( strValue ); 105 LOG.debug( "Syntax valid for '{}'", value ); 106 return true; 107 } 108 catch ( ParseException pe ) 109 { 110 LOG.debug( "Syntax invalid for '{}'", value ); 111 return false; 112 } 113 } 114}