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