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.ObjectClassDescriptionSchemaParser;
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     * object class descripton syntax according to RFC 4512, par 4.2.1:
036     * 
037     * <pre>
038     * ObjectClassDescription = 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 "SUP" SP oids ]       ; superior object classes
044     *     [ SP kind ]                ; kind of class
045     *     [ SP "MUST" SP oids ]      ; attribute types
046     *     [ SP "MAY" SP oids ]       ; attribute types
047     *     extensions WSP RPAREN
048     *
049     * kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
050     * 
051     * extensions = *( SP xstring SP qdstrings )
052     * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
053     * </pre>
054     * 
055     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
056     * @version $Rev$
057     */
058    public class ObjectClassDescriptionSyntaxChecker extends SyntaxChecker
059    {
060        /** A logger for this class */
061        private static final Logger LOG = LoggerFactory.getLogger( ObjectClassDescriptionSyntaxChecker.class );
062    
063        /** The serialVersionUID */
064        private static final long serialVersionUID = 1L;
065    
066        /** The schema parser used to parse the ObjectClassDescription Syntax */
067        private ObjectClassDescriptionSchemaParser schemaParser = new ObjectClassDescriptionSchemaParser();
068    
069        /**
070         * Creates a new instance of ObjectClassDescriptionSyntaxChecker.
071         */
072        public ObjectClassDescriptionSyntaxChecker()
073        {
074            super( SchemaConstants.OBJECT_CLASS_DESCRIPTION_SYNTAX );
075        }
076        
077    
078        /**
079         * {@inheritDoc}
080         */
081        public boolean isValidSyntax( Object value )
082        {
083            String strValue = null;
084    
085            if ( value == null )
086            {
087                LOG.debug( "Syntax invalid for '{}'", value );
088                return false;
089            }
090    
091            if ( value instanceof String )
092            {
093                strValue = ( String ) value;
094            }
095            else if ( value instanceof byte[] )
096            {
097                strValue = StringTools.utf8ToString( ( byte[] ) value );
098            }
099            else
100            {
101                strValue = value.toString();
102            }
103    
104            try
105            {
106                schemaParser.parseObjectClassDescription( strValue );
107                LOG.debug( "Syntax valid for '{}'", value );
108                return true;
109            }
110            catch ( ParseException pe )
111            {
112                LOG.debug( "Syntax invalid for '{}'", value );
113                return false;
114            }
115        }
116    }