author | ohair |
Tue, 28 Dec 2010 15:53:50 -0800 | |
changeset 7668 | d4a77089c587 |
parent 5627 | e636ac7a63a4 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
7668 | 2 |
* Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved. |
2 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 24 |
*/ |
25 |
||
26 |
package javax.naming.ldap; |
|
27 |
||
28 |
import javax.naming.event.NamingListener; |
|
29 |
||
30 |
/** |
|
31 |
* This interface is for handling <tt>UnsolicitedNotificationEvent</tt>. |
|
32 |
* "Unsolicited notification" is defined in |
|
5604
d5b97d8361d0
6952701: Use http://www.ietf.org/rfc for rfc references in jdk public APIs
sherman
parents:
2
diff
changeset
|
33 |
* <A HREF="http://www.ietf.org/rfc/rfc2251.txt">RFC 2251</A>. |
2 | 34 |
* It allows the server to send unsolicited notifications to the client. |
35 |
* A <tt>UnsolicitedNotificationListener</tt> must: |
|
36 |
*<ol> |
|
37 |
* <li>Implement this interface and its method |
|
38 |
* <li>Implement <tt>NamingListener.namingExceptionThrown()</tt> so |
|
39 |
* that it will be notified of exceptions thrown while attempting to |
|
40 |
* collect unsolicited notification events. |
|
41 |
* <li>Register with the context using one of the <tt>addNamingListener()</tt> |
|
42 |
* methods from <tt>EventContext</tt> or <tt>EventDirContext</tt>. |
|
43 |
* Only the <tt>NamingListener</tt> argument of these methods are applicable; |
|
44 |
* the rest are ignored for a <tt>UnsolicitedNotificationListener</tt>. |
|
45 |
* (These arguments might be applicable to the listener if it implements |
|
46 |
* other listener interfaces). |
|
47 |
*</ol> |
|
48 |
* |
|
49 |
* @author Rosanna Lee |
|
50 |
* @author Scott Seligman |
|
51 |
* @author Vincent Ryan |
|
52 |
* |
|
53 |
* @see UnsolicitedNotificationEvent |
|
54 |
* @see UnsolicitedNotification |
|
55 |
* @see javax.naming.event.EventContext#addNamingListener |
|
56 |
* @see javax.naming.event.EventDirContext#addNamingListener |
|
57 |
* @see javax.naming.event.EventContext#removeNamingListener |
|
58 |
* @since 1.3 |
|
59 |
*/ |
|
60 |
public interface UnsolicitedNotificationListener extends NamingListener { |
|
61 |
||
62 |
/** |
|
63 |
* Called when an unsolicited notification has been received. |
|
64 |
* |
|
65 |
* @param evt The non-null UnsolicitedNotificationEvent |
|
66 |
*/ |
|
67 |
void notificationReceived(UnsolicitedNotificationEvent evt); |
|
68 |
} |