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.List;
21  
22  import javax.naming.NamingException;
23  
24  
25  /***
26   * Monitor used to track notable OidRegistry events.
27   *
28   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29   * @version $Rev: 264732 $
30   */
31  public interface OidRegistryMonitor
32  {
33      /***
34       * Monitors situations where an OID is used to resolve an OID.  The caller
35       * does not know that the argument is the same as the return value.
36       * 
37       * @param oid the OID argument and return value
38       */
39      void getOidWithOid( String oid );
40      
41      /***
42       * Monitors when an OID is resolved successfully for a name.
43       *  
44       * @param name the name used to lookup an OID
45       * @param oid the OID returned for the name
46       */
47      void oidResolved( String name, String oid );
48      
49      /***
50       * Monitors when an OID is resolved successfully by using a normalized form
51       * of the name.
52       *  
53       * @param name the name used to lookup an OID
54       * @param normalized the normalized name that mapped to the OID
55       * @param oid the OID returned for the name
56       */
57      void oidResolved( String name, String normalized, String oid );
58      
59      /***
60       * Monitors when resolution of an OID by name fails.
61       * 
62       * @param name the name used to lookup an OID
63       * @param fault the exception thrown for the failure after this call
64       */
65      void oidResolutionFailed( String name, NamingException fault );
66      
67      /***
68       * Monitors when a name lookups fail due to the use of an unknown OID.
69       *  
70       * @param oid the OID used to lookup object names
71       * @param fault the exception thrown for the failure after this call
72       */
73      void oidDoesNotExist( String oid, NamingException fault );
74      
75      /***
76       * Monitors situations where a primary name is resolved for a OID.
77       * 
78       * @param oid the OID used for the lookup
79       * @param primaryName the primary name found for the OID
80       */
81      void nameResolved( String oid, String primaryName );
82  
83      /***
84       * Monitors situations where a names are resolved for a OID.
85       * 
86       * @param oid the OID used for the lookup
87       * @param names the names found for the OID
88       */
89      void namesResolved( String oid, List names );
90      
91      /***
92       * Monitors the successful registration of a name for an OID.
93       * 
94       * @param name the one of many names registered with an OID
95       * @param oid the OID to be associated with the name
96       */
97      void registered( String name, String oid );
98  }