View Javadoc

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 java.util.Iterator;
21  
22  import javax.naming.NamingException;
23  
24  import org.apache.ldap.common.schema.NameForm;
25  
26  
27  /***
28   * An NameForm registry service interface.
29   *
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   * @version $Rev: 264732 $
32   */
33  public interface NameFormRegistry
34  {
35      /***
36       * Registers a NameForm with this registry.
37       * 
38       * @param schema the name of the schema the NameForm is associated with
39       * @param nameForm the nameForm to register
40       * @throws NamingException if the NameForm is already registered or the
41       * registration operation is not supported
42       */
43      void register( String schema, NameForm nameForm ) throws NamingException;
44      
45      /***
46       * Looks up a nameForm by its unique Object Identifier or by name.
47       * 
48       * @param id the object identifier or name
49       * @return the NameForm instance for the id
50       * @throws NamingException if the NameForm does not exist
51       */
52      NameForm lookup( String id ) 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 an nameForm exists.
65       * 
66       * @param id the object identifier or name
67       * @return true if an nameForm definition exists for the oid, false
68       * otherwise
69       */
70      boolean hasNameForm( String id );
71  
72      /***
73       * Lists all the NameForms within this registry.
74       *
75       * @return an Iterator over all the NameForms within this registry
76       */ 
77      Iterator list();
78  }