001/*
002 * Copyright 2007-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2007-2020 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2008-2020 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk;
037
038
039
040import com.unboundid.util.Extensible;
041import com.unboundid.util.ThreadSafety;
042import com.unboundid.util.ThreadSafetyLevel;
043
044
045
046/**
047 * This interface defines a method that may be invoked if an unsolicited
048 * notification is received from the directory server.  An unsolicited
049 * notification handler should be defined in the {@link LDAPConnectionOptions}
050 * for an {@link LDAPConnection} to be called whenever an unsolicited
051 * notification is received for that connection.
052 * <BR><BR>
053 * An unsolicited notification is a type of extended response that is sent from
054 * the server to the client without a corresponding request, and it may be used
055 * to alert the client of a significant server-side event.  For example,
056 * section 4.4.1 of <A HREF="http://www.ietf.org/rfc/rfc4511.txt">RFC 4511</A>
057 * defines a notice of disconnection unsolicited notification that can be used
058 *  by the server to inform the client that it is about to close the connection.
059 * <BR><BR>
060 * Implementations of this interface should be threadsafe to ensure that
061 * multiple connections will be able to safely use the same
062 * {@code UnsolicitedNotificationHandler} instance.
063 */
064@Extensible()
065@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
066public interface UnsolicitedNotificationHandler
067{
068  /**
069   * Performs any processing that may be necessary in response to the provided
070   * unsolicited notification that has been received from the server.
071   *
072   * @param  connection    The connection on which the unsolicited notification
073   *                       was received.
074   * @param  notification  The unsolicited notification that has been received
075   *                       from the server.
076   */
077  void handleUnsolicitedNotification(LDAPConnection connection,
078                                     ExtendedResult notification);
079}