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.syntaxes;
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.AbstractSyntaxChecker;
027 import org.apache.directory.shared.ldap.schema.parsers.ObjectClassDescriptionSchemaParser;
028 import org.apache.directory.shared.ldap.util.StringTools;
029
030
031 /**
032 * A SyntaxChecker which verifies that a value follows the
033 * object class descripton syntax according to RFC 4512, par 4.2.1:
034 *
035 * <pre>
036 * ObjectClassDescription = LPAREN WSP
037 * numericoid ; object identifier
038 * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
039 * [ SP "DESC" SP qdstring ] ; description
040 * [ SP "OBSOLETE" ] ; not active
041 * [ SP "SUP" SP oids ] ; superior object classes
042 * [ SP kind ] ; kind of class
043 * [ SP "MUST" SP oids ] ; attribute types
044 * [ SP "MAY" SP oids ] ; attribute types
045 * extensions WSP RPAREN
046 *
047 * kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
048 *
049 * extensions = *( SP xstring SP qdstrings )
050 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
051 * </pre>
052 *
053 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
054 * @version $Rev$
055 */
056 public class ObjectClassDescriptionSyntaxChecker extends AbstractSyntaxChecker
057 {
058 /** The schema parser used to parse the ObjectClassDescription Syntax */
059 private ObjectClassDescriptionSchemaParser schemaParser = new ObjectClassDescriptionSchemaParser();
060
061
062 /**
063 *
064 * Creates a new instance of ObjectClassDescriptionSyntaxChecker.
065 *
066 */
067 public ObjectClassDescriptionSyntaxChecker()
068 {
069 super( SchemaConstants.OBJECT_CLASS_DESCRIPTION_SYNTAX );
070 }
071
072
073 /**
074 *
075 * Creates a new instance of ObjectClassDescriptionSyntaxChecker.
076 *
077 * @param oid the oid to associate with this new SyntaxChecker
078 *
079 */
080 protected ObjectClassDescriptionSyntaxChecker( String oid )
081 {
082 super( oid );
083 }
084
085 /* (non-Javadoc)
086 * @see org.apache.directory.shared.ldap.schema.SyntaxChecker#isValidSyntax(java.lang.Object)
087 */
088 public boolean isValidSyntax( Object value )
089 {
090 String strValue = null;
091
092 if ( value == null )
093 {
094 return false;
095 }
096
097 if ( value instanceof String )
098 {
099 strValue = ( String ) value;
100 }
101 else if ( value instanceof byte[] )
102 {
103 strValue = StringTools.utf8ToString( ( byte[] ) value );
104 }
105 else
106 {
107 strValue = value.toString();
108 }
109
110 try
111 {
112 schemaParser.parseObjectClassDescription( strValue );
113 return true;
114 }
115 catch ( ParseException pe )
116 {
117 return false;
118 }
119 }
120 }