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.syntaxCheckers;
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.SyntaxChecker;
027 import org.apache.directory.shared.ldap.schema.parsers.MatchingRuleDescriptionSchemaParser;
028 import org.apache.directory.shared.ldap.util.StringTools;
029 import org.slf4j.Logger;
030 import org.slf4j.LoggerFactory;
031
032
033 /**
034 * A SyntaxChecker which verifies that a value follows the
035 * matching rule descripton syntax according to RFC 4512, par 4.2.3:
036 *
037 * <pre>
038 * MatchingRuleDescription = 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 "SYNTAX" SP numericoid ; assertion syntax
044 * extensions WSP RPAREN ; extensions
045 *
046 * extensions = *( SP xstring SP qdstrings )
047 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
048 *
049 * </pre>
050 *
051 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
052 * @version $Rev$
053 */
054 public class MatchingRuleDescriptionSyntaxChecker extends SyntaxChecker
055 {
056 /** A logger for this class */
057 private static final Logger LOG = LoggerFactory.getLogger( MatchingRuleDescriptionSyntaxChecker.class );
058
059 /** The serialVersionUID */
060 private static final long serialVersionUID = 1L;
061
062 /** The schema parser used to parse the MatchingRuleDescription Syntax */
063 private MatchingRuleDescriptionSchemaParser schemaParser = new MatchingRuleDescriptionSchemaParser();
064
065
066 /**
067 *
068 * Creates a new instance of MatchingRuleDescriptionSchemaParser.
069 *
070 */
071 public MatchingRuleDescriptionSyntaxChecker()
072 {
073 super( SchemaConstants.MATCHING_RULE_DESCRIPTION_SYNTAX );
074 }
075
076
077 /**
078 * {@inheritDoc}
079 */
080 public boolean isValidSyntax( Object value )
081 {
082 String strValue = null;
083
084 if ( value == null )
085 {
086 LOG.debug( "Syntax invalid for '{}'", value );
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.parseMatchingRuleDescription( strValue );
106 LOG.debug( "Syntax valid for '{}'", value );
107
108 return true;
109 }
110 catch ( ParseException pe )
111 {
112 LOG.debug( "Syntax invalid for '{}'", value );
113 return false;
114 }
115 }
116
117 }