KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > naming > ldap > UnsolicitedNotification


1 /*
2  * @(#)UnsolicitedNotification.java 1.8 03/12/19
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */
7
8 package javax.naming.ldap;
9
10 import javax.naming.NamingException JavaDoc;
11
12 /**
13  * This interface represents an unsolicited notification as defined in
14  * <A HREF="ftp://ftp.isi.edu/in-notes/rfc2251.txt">RFC 2251</A>.
15  * An unsolicited notification is sent by the LDAP server to the LDAP
16  * client without any provocation from the client.
17  * Its format is that of an extended response (<tt>ExtendedResponse</tt>).
18  *
19  * @author Rosanna Lee
20  * @author Scott Seligman
21  * @author Vincent Ryan
22  * @version 1.8 03/12/19
23  *
24  * @see ExtendedResponse
25  * @see UnsolicitedNotificationEvent
26  * @see UnsolicitedNotificationListener
27  * @since 1.3
28  */
29
30 public interface UnsolicitedNotification extends ExtendedResponse JavaDoc, HasControls JavaDoc {
31     /**
32      * Retrieves the referral(s) sent by the server.
33      *
34      * @return A possibly null array of referrals, each of which is represented
35      * by a URL string. If null, no referral was sent by the server.
36      */
37     public String JavaDoc[] getReferrals();
38
39     /**
40      * Retrieves the exception as constructed using information
41      * sent by the server.
42      * @return A possibly null exception as constructed using information
43      * sent by the server. If null, a "success" status was indicated by
44      * the server.
45      */
46     public NamingException JavaDoc getException();
47 }
48
Popular Tags