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