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;
021    
022    
023    import javax.naming.NamingException;
024    
025    
026    /**
027     * Used to validate values of a particular syntax. This interface does not
028     * correlate to any LDAP or X.500 construct. It has been created as a means to
029     * enforce a syntax within the Eve server.
030     * 
031     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032     * @version $Rev: 736240 $, $Date: 2009-01-21 07:33:48 +0100 (Mer, 21 jan 2009) $
033     */
034    public interface SyntaxChecker
035    {
036        /**
037         * Gets the OID of the attribute syntax.
038         * 
039         * @return the object identifier of the Syntax this SyntaxChecker validates
040         */
041        String getSyntaxOid();
042    
043    
044        /**
045         * Determines if the attribute's value conforms to the attribute syntax.
046         * 
047         * @param value the value of some attribute with the syntax
048         * @return true if the value is in the valid syntax, false otherwise
049         */
050        boolean isValidSyntax( Object value );
051    
052    
053        /**
054         * Asserts whether or not the attribute's value conforms to the attribute
055         * syntax.
056         * 
057         * @param value the value of some attribute with the syntax
058         * @throws NamingException if the value does not conform to the attribute syntax.
059         */
060        void assertSyntax( Object value ) throws NamingException;
061    }