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.syntaxes;
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.AbstractSyntaxChecker;
027    import org.apache.directory.shared.ldap.schema.parsers.LdapSyntaxDescriptionSchemaParser;
028    import org.apache.directory.shared.ldap.util.StringTools;
029    
030    
031    /**
032     * A SyntaxChecker which verifies that a value follows the
033     * LDAP syntax descripton syntax according to RFC 4512, par 4.2.2:
034     * 
035     * <pre>
036     * SyntaxDescription = LPAREN WSP
037     *    numericoid                 ; object identifier
038     *    [ SP "DESC" SP qdstring ]  ; description
039     *    extensions WSP RPAREN      ; extensions
040     * </pre>
041     * 
042     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
043     * @version $Rev$
044     */
045    public class LdapSyntaxDescriptionSyntaxChecker extends AbstractSyntaxChecker
046    {
047        /** The schema parser used to parse the LdapSyntaxDescription Syntax */
048        private LdapSyntaxDescriptionSchemaParser schemaParser = new LdapSyntaxDescriptionSchemaParser();
049    
050    
051        /**
052         * 
053         * Creates a new instance of AttributeTypeDescriptionSchemaParser.
054         *
055         */
056        public LdapSyntaxDescriptionSyntaxChecker()
057        {
058            super( SchemaConstants.LDAP_SYNTAX_DESCRIPTION_SYNTAX );
059        }
060    
061        /**
062         * 
063         * Creates a new instance of LdapSyntaxDescriptionSyntaxChecker.
064         * 
065         * @param oid the oid to associate with this new SyntaxChecker
066         *
067         */
068        protected LdapSyntaxDescriptionSyntaxChecker( String oid )
069        {
070            super( oid );
071        }
072        
073        /* (non-Javadoc)
074         * @see org.apache.directory.shared.ldap.schema.SyntaxChecker#isValidSyntax(java.lang.Object)
075         */
076        public boolean isValidSyntax( Object value )
077        {
078            String strValue =null;
079    
080            if ( value == null )
081            {
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 = StringTools.utf8ToString( ( byte[] ) value );
092            }
093            else
094            {
095                strValue = value.toString();
096            }
097    
098            try
099            {
100                schemaParser.parseLdapSyntaxDescription( strValue );
101                return true;
102            }
103            catch ( ParseException pe )
104            {
105                return false;
106            }
107        }
108    }