SyntaxRegistry


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.Syntax;
21  
22  import javax.naming.NamingException  ;
23  import java.util.Iterator  ;
24  
25  
26  /**
27   * Manages the lookup and registration of Syntaxes within the system by OID.
28   *
29   * @author <a HREF="mailto:dev@directory.apache.org">Apache Directory Project</a>
30   * @version $Rev: 169198 $
31   */
32  public interface SyntaxRegistry
33  {
34      /**
35       * Looks up a Syntax by its unique Object Identifier or by name.
36       * 
37       * @param id the object identifier or name
38       * @return the Syntax for the id
39       * @throws NamingException if there is a backing store failure or the Syntax
40       * does not exist.
41       */
42      Syntax lookup( String   id ) throws NamingException  ;
43      
44      /**
45       * Registers a Syntax with this registry.  
46       * 
47       * @param schema the name of the schema the Syntax is associated with
48       * @param syntax the Syntax to register
49       * @throws NamingException if the syntax is already registered or the 
50       * registration operation is not supported
51       */
52      void register( String   schema, Syntax syntax ) throws NamingException  ;
53  
54      /**
55       * Gets the name of the schema this schema object is associated with.
56       *
57       * @param id the object identifier or the name
58       * @return the schema name
59       * @throws NamingException if the schema object does not exist
60       */
61      String   getSchemaName( String   id ) throws NamingException  ;
62  
63      /**
64       * Checks to see if a Syntax exists.  Backing store failures simply return
65       * false.
66       * 
67       * @param id the object identifier or name
68       * @return true if a Syntax definition exists for the id, false otherwise
69       */
70      boolean hasSyntax( String   id );
71  
72      /**
73       * Lists all the Syntaxes within this registry.
74       *
75       * @return an Iterator over all the Syntaxes within this registry
76       */
77      Iterator   list();
78  }
79
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags