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.LdapSyntaxDescriptionSchemaParser;
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 * 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 * @version $Rev$
046 */
047 public class LdapSyntaxDescriptionSyntaxChecker extends SyntaxChecker
048 {
049 /** A logger for this class */
050 private static final Logger LOG = LoggerFactory.getLogger( LdapSyntaxDescriptionSyntaxChecker.class );
051
052 /** The serialVersionUID */
053 private static final long serialVersionUID = 1L;
054
055 /** The schema parser used to parse the LdapSyntax description Syntax */
056 private LdapSyntaxDescriptionSchemaParser schemaParser = new LdapSyntaxDescriptionSchemaParser();
057
058
059 /**
060 *
061 * Creates a new instance of LdapSyntaxDescriptionSyntaxChecker.
062 *
063 */
064 public LdapSyntaxDescriptionSyntaxChecker()
065 {
066 super( SchemaConstants.LDAP_SYNTAX_DESCRIPTION_SYNTAX );
067 }
068
069 /**
070 * {@inheritDoc}
071 */
072 public boolean isValidSyntax( Object value )
073 {
074 String strValue =null;
075
076 if ( value == null )
077 {
078 LOG.debug( "Syntax invalid for '{}'", value );
079 return false;
080 }
081
082 if ( value instanceof String )
083 {
084 strValue = ( String ) value;
085 }
086 else if ( value instanceof byte[] )
087 {
088 strValue = StringTools.utf8ToString( ( byte[] ) value );
089 }
090 else
091 {
092 strValue = value.toString();
093 }
094
095 try
096 {
097 schemaParser.parseLdapSyntaxDescription( strValue );
098 LOG.debug( "Syntax valid for '{}'", value );
099
100 return true;
101 }
102 catch ( ParseException pe )
103 {
104 LOG.debug( "Syntax invalid for '{}'", value );
105 return false;
106 }
107 }
108 }