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