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