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 */
020package org.apache.directory.shared.ldap.model.schema.syntaxCheckers;
021
022
023import java.text.ParseException;
024
025import org.apache.directory.shared.ldap.model.constants.SchemaConstants;
026import org.apache.directory.shared.ldap.model.schema.SyntaxChecker;
027import org.apache.directory.shared.ldap.model.schema.parsers.MatchingRuleUseDescriptionSchemaParser;
028import org.apache.directory.shared.util.Strings;
029import org.slf4j.Logger;
030import org.slf4j.LoggerFactory;
031
032
033/**
034 * A SyntaxChecker which verifies that a value follows the
035 * matching rule use descripton syntax according to RFC 4512, par 4.2.4:
036 * 
037 *  <pre>
038 * MatchingRuleUseDescription = 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 "APPLIES" SP oids       ; attribute types
044 *    extensions WSP RPAREN      ; extensions
045 * 
046 * </pre>
047 * 
048 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
049 */
050@SuppressWarnings("serial")
051public class MatchingRuleUseDescriptionSyntaxChecker extends SyntaxChecker
052{
053    /** A logger for this class */
054    private static final Logger LOG = LoggerFactory.getLogger( MatchingRuleUseDescriptionSyntaxChecker.class );
055
056    /** The schema parser used to parse the MatchingRuleUseDescription Syntax */
057    private MatchingRuleUseDescriptionSchemaParser schemaParser = new MatchingRuleUseDescriptionSchemaParser();
058
059
060    /**
061     * 
062     * Creates a new instance of MatchingRuleUseDescriptionSchemaParser.
063     *
064     */
065    public MatchingRuleUseDescriptionSyntaxChecker()
066    {
067        super( SchemaConstants.MATCHING_RULE_USE_DESCRIPTION_SYNTAX );
068    }
069    
070
071    /**
072     * {@inheritDoc}
073     */
074    public boolean isValidSyntax( Object value )
075    {
076        String strValue = null;
077
078        if ( value == null )
079        {
080            LOG.debug( "Syntax invalid for 'null'" );
081            return false;
082        }
083
084        if ( value instanceof String )
085        {
086            strValue = ( String ) value;
087        }
088        else if ( value instanceof byte[] )
089        {
090            strValue = Strings.utf8ToString((byte[]) value);
091        }
092        else
093        {
094            strValue = value.toString();
095        }
096
097        try
098        {
099            schemaParser.parseMatchingRuleUseDescription( strValue );
100            LOG.debug( "Syntax valid for '{}'", value );
101
102            return true;
103        }
104        catch ( ParseException pe )
105        {
106            LOG.debug( "Syntax invalid for '{}'", value );
107            return false;
108        }
109    }
110    
111}