1. /*
  2. * @(#)UnsolicitedNotification.java 1.5 00/02/02
  3. *
  4. * Copyright 1999, 2000 Sun Microsystems, Inc. All Rights Reserved.
  5. *
  6. * This software is the proprietary information of Sun Microsystems, Inc.
  7. * Use is subject to license terms.
  8. *
  9. */
  10. package javax.naming.ldap;
  11. import javax.naming.NamingException;
  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.5 00/02/02
  23. *
  24. * @see ExtendedResponse
  25. * @see UnsolicitedNotificationEvent
  26. * @see UnsolicitedNotificationListener
  27. * @since 1.3
  28. */
  29. public interface UnsolicitedNotification extends ExtendedResponse, HasControls {
  30. /**
  31. * Retrieves the referral(s) sent by the server.
  32. *
  33. * @return A possibly null array of referrals, each of which is represented
  34. * by a URL string. If null, no referral was sent by the server.
  35. */
  36. public String[] getReferrals();
  37. /**
  38. * Retrieves the exception as constructed using information
  39. * sent by the server.
  40. * @return A possibly null exception as constructed using information
  41. * sent by the server. If null, a "success" status was indicated by
  42. * the server.
  43. */
  44. public NamingException getException();
  45. }