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.LdapSyntaxDescriptionSchemaParser;
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 * LDAP syntax descripton syntax according to RFC 4512, par 4.2.2:
036 * 
037 * <pre>
038 * SyntaxDescription = LPAREN WSP
039 *    numericoid                 ; object identifier
040 *    [ SP "DESC" SP qdstring ]  ; description
041 *    extensions WSP RPAREN      ; extensions
042 * </pre>
043 * 
044 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
045 */
046@SuppressWarnings("serial")
047public class LdapSyntaxDescriptionSyntaxChecker extends SyntaxChecker
048{
049    /** A logger for this class */
050    private static final Logger LOG = LoggerFactory.getLogger( LdapSyntaxDescriptionSyntaxChecker.class );
051
052    /** The schema parser used to parse the LdapSyntax description Syntax */
053    private LdapSyntaxDescriptionSchemaParser schemaParser = new LdapSyntaxDescriptionSchemaParser();
054
055
056    /**
057     * 
058     * Creates a new instance of LdapSyntaxDescriptionSyntaxChecker.
059     *
060     */
061    public LdapSyntaxDescriptionSyntaxChecker()
062    {
063        super( SchemaConstants.LDAP_SYNTAX_DESCRIPTION_SYNTAX );
064    }
065
066
067    /**
068     * {@inheritDoc}
069     */
070    public boolean isValidSyntax( Object value )
071    {
072        String strValue = null;
073
074        if ( value == null )
075        {
076            LOG.debug( "Syntax invalid for 'null'" );
077            return false;
078        }
079
080        if ( value instanceof String )
081        {
082            strValue = ( String ) value;
083        }
084        else if ( value instanceof byte[] )
085        {
086            strValue = Strings.utf8ToString( ( byte[] ) value );
087        }
088        else
089        {
090            strValue = value.toString();
091        }
092
093        try
094        {
095            schemaParser.parseLdapSyntaxDescription( strValue );
096            LOG.debug( "Syntax valid for '{}'", value );
097
098            return true;
099        }
100        catch ( ParseException pe )
101        {
102            LOG.debug( "Syntax invalid for '{}'", value );
103            return false;
104        }
105    }
106}