KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ldap > server > schema > SyntaxCheckerRegistry


1 /*
2  * Copyright 2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */

17 package org.apache.ldap.server.schema;
18
19
20 import org.apache.ldap.common.schema.SyntaxChecker;
21
22 import javax.naming.NamingException JavaDoc;
23
24
25 /**
26  * SyntaxChecker registry component's service interface.
27  *
28  * @author <a HREF="mailto:dev@directory.apache.org">Apache Directory Project</a>
29  * @version $Rev: 169198 $
30  */

31 public interface SyntaxCheckerRegistry
32 {
33     /**
34      * Registers a SyntaxChecker with this registry.
35      *
36      * @param schema the name of the schema the SyntaxChecker is associated with
37      * @param syntaxChecker the SyntaxChecker to register
38      * @throws NamingException if the SyntaxChecker is already registered or the
39      * registration operation is not supported
40      */

41     void register( String JavaDoc schema, String JavaDoc oid, SyntaxChecker syntaxChecker )
42         throws NamingException JavaDoc;
43     
44     /**
45      * Looks up a SyntaxChecker by its unique Object Identifier.
46      *
47      * @param oid the object identifier
48      * @return the SyntaxChecker for the oid
49      * @throws NamingException if there is a backing store failure or the
50      * SyntaxChecker does not exist.
51      */

52     SyntaxChecker lookup( String JavaDoc oid ) throws NamingException JavaDoc;
53
54     /**
55      * Gets the name of the schema this schema object is associated with.
56      *
57      * @param oid the object identifier
58      * @return the schema name
59      * @throws NamingException if the schema object does not exist
60      */

61     String JavaDoc getSchemaName( String JavaDoc oid ) throws NamingException JavaDoc;
62
63     /**
64      * Checks to see if a SyntaxChecker exists. Backing store failures simply
65      * return false.
66      *
67      * @param oid the object identifier
68      * @return true if a SyntaxChecker definition exists for the oid, false
69      * otherwise
70      */

71     boolean hasSyntaxChecker( String JavaDoc oid );
72 }
73
Popular Tags