/*
 * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.naming.ldap;

import javax.naming.NamingException;

This interface represents an unsolicited notification as defined in RFC 2251. An unsolicited notification is sent by the LDAP server to the LDAP client without any provocation from the client. Its format is that of an extended response (ExtendedResponse).
Author:Rosanna Lee, Scott Seligman, Vincent Ryan
See Also:
Since:1.3
/** * This interface represents an unsolicited notification as defined in * <A HREF="ftp://ftp.isi.edu/in-notes/rfc2251.txt">RFC 2251</A>. * An unsolicited notification is sent by the LDAP server to the LDAP * client without any provocation from the client. * Its format is that of an extended response (<tt>ExtendedResponse</tt>). * * @author Rosanna Lee * @author Scott Seligman * @author Vincent Ryan * * @see ExtendedResponse * @see UnsolicitedNotificationEvent * @see UnsolicitedNotificationListener * @since 1.3 */
public interface UnsolicitedNotification extends ExtendedResponse, HasControls {
Retrieves the referral(s) sent by the server.
Returns:A possibly null array of referrals, each of which is represented by a URL string. If null, no referral was sent by the server.
/** * Retrieves the referral(s) sent by the server. * * @return A possibly null array of referrals, each of which is represented * by a URL string. If null, no referral was sent by the server. */
public String[] getReferrals();
Retrieves the exception as constructed using information sent by the server.
Returns:A possibly null exception as constructed using information sent by the server. If null, a "success" status was indicated by the server.
/** * Retrieves the exception as constructed using information * sent by the server. * @return A possibly null exception as constructed using information * sent by the server. If null, a "success" status was indicated by * the server. */
public NamingException getException(); }