org.ietf.ldap.LDAPMessageQueue Maven / Gradle / Ivy

/* **************************************************************************
 * $OpenLDAP$
 *
 * Copyright (C) 1999, 2000, 2001 Novell, Inc. All Rights Reserved.
 *
 * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND
 * TREATIES. USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT
 * TO VERSION 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS
 * AVAILABLE AT HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE"
 * IN THE TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION
 * OF THIS WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP
 * PUBLIC LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT
 * THE PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.
 ******************************************************************************/

package org.ietf.ldap;

/**
 *  The common interface for LDAPResponseQueue and LDAPSearchQueue.
 *
 * @see 
            com.novell.ldap.LDAPMessageQueue
 */
public interface LDAPMessageQueue
{
   /**
    * Returns the message IDs for all outstanding requests.
    *
    * @see 
            com.novell.ldap.LDAPMessageQueue.getMessageIDs()
    */
   public int[] getMessageIDs();

   /**
    * Returns the response from an LDAP request.
    *
    * @see 
            com.novell.ldap.LDAPMessageQueue.getResponse()
    */
   public LDAPMessage getResponse()
            throws LDAPException;

   /**
    * Returns the response from an LDAP request for a particular msg id.
    *
    * @see 
            com.novell.ldap.LDAPMessageQueue.getResponse(int)
    */
   public LDAPMessage getResponse(int msgid)
            throws LDAPException;

   /**
    * Reports whether a response has been received from the server.
    *
    * @see 
            com.novell.ldap.LDAPMessageQueue.isResponseReceived()
    */
   public boolean isResponseReceived();

   /**
    * Reports whether a response has been received from the server for
    * a particular msg id.
    *
    * @see 
            com.novell.ldap.LDAPMessageQueue.isResponseReceived(int)
    */
   public boolean isResponseReceived(int msgid);

   /**
    * Merges two response queues by moving the current and
    *
    * @see 
            com.novell.ldap.LDAPMessageQueue.merge(LDAPMessageQueue)
    */
   public void merge(LDAPMessageQueue queue2);
}