com.unboundid.ldap.sdk.UnsolicitedNotificationHandler Maven / Gradle / Ivy
/*
* Copyright 2007-2017 UnboundID Corp.
* All Rights Reserved.
*/
/*
* Copyright (C) 2008-2017 UnboundID Corp.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program 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 for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk;
import com.unboundid.util.Extensible;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This interface defines a method that may be invoked if an unsolicited
* notification is received from the directory server. An unsolicited
* notification handler should be defined in the {@link LDAPConnectionOptions}
* for an {@link LDAPConnection} to be called whenever an unsolicited
* notification is received for that connection.
*
* An unsolicited notification is a type of extended response that is sent from
* the server to the client without a corresponding request, and it may be used
* to alert the client of a significant server-side event. For example,
* section 4.4.1 of RFC 4511
* defines a notice of disconnection unsolicited notification that can be used
* by the server to inform the client that it is about to close the connection.
*
* Implementations of this interface should be threadsafe to ensure that
* multiple connections will be able to safely use the same
* {@code UnsolicitedNotificationHandler} instance.
*/
@Extensible()
@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
public interface UnsolicitedNotificationHandler
{
/**
* Performs any processing that may be necessary in response to the provided
* unsolicited notification that has been received from the server.
*
* @param connection The connection on which the unsolicited notification
* was received.
* @param notification The unsolicited notification that has been received
* from the server.
*/
void handleUnsolicitedNotification(final LDAPConnection connection,
final ExtendedResult notification);
}