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.DITContentRuleDescriptionSchemaParser;
028 import org.apache.directory.shared.ldap.util.StringTools;
029
030
031 /**
032 * A SyntaxChecker which verifies that a value follows the
033 * DIT content rule descripton syntax according to RFC 4512, par 4.2.6:
034 *
035 * <pre>
036 * DITContentRuleDescription = 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 "AUX" SP oids ] ; auxiliary object classes
042 * [ SP "MUST" SP oids ] ; attribute types
043 * [ SP "MAY" SP oids ] ; attribute types
044 * [ SP "NOT" SP oids ] ; attribute types
045 * extensions WSP RPAREN ; extensions
046 * </pre>
047 *
048 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
049 * @version $Rev$
050 */
051 public class DITContentRuleDescriptionSyntaxChecker extends AbstractSyntaxChecker
052 {
053 /** The schema parser used to parse the DITContentRuleDescription Syntax */
054 private DITContentRuleDescriptionSchemaParser schemaParser = new DITContentRuleDescriptionSchemaParser();
055
056
057 /**
058 *
059 * Creates a new instance of DITContentRuleDescriptionSyntaxChecker.
060 *
061 */
062 public DITContentRuleDescriptionSyntaxChecker()
063 {
064 super( SchemaConstants.DIT_CONTENT_RULE_SYNTAX );
065 }
066
067
068 /**
069 *
070 * Creates a new instance of DITContentRuleDescriptionSyntaxChecker.
071 *
072 * @param oid the oid to associate with this new SyntaxChecker
073 *
074 */
075 protected DITContentRuleDescriptionSyntaxChecker( String oid )
076 {
077 super( oid );
078 }
079
080 /* (non-Javadoc)
081 * @see org.apache.directory.shared.ldap.schema.SyntaxChecker#isValidSyntax(java.lang.Object)
082 */
083 public boolean isValidSyntax( Object value )
084 {
085 String strValue = null;
086
087 if ( value == null )
088 {
089 return false;
090 }
091
092 if ( value instanceof String )
093 {
094 strValue = ( String ) value;
095 }
096 else if ( value instanceof byte[] )
097 {
098 strValue = StringTools.utf8ToString( ( byte[] ) value );
099 }
100 else
101 {
102 strValue = value.toString();
103 }
104
105 try
106 {
107 schemaParser.parseDITContentRuleDescription( strValue );
108 return true;
109 }
110 catch ( ParseException pe )
111 {
112 return false;
113 }
114 }
115 }