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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jldap Show documentation
There is a newer version: 2009-10-07
/* **************************************************************************
 * $OpenLDAP: pkg/jldap/org/ietf/ldap/LDAPSearchQueue.java,v 1.2 2004/01/16 04:55:00 sunilk Exp $
 *
 * 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;

/**
 *  A mechanism for queuing asynchronous search results
 *  and references received from a server.
 *
 *  @see 
            com.novell.ldap.LDAPSearchQueue
 */
public class LDAPSearchQueue implements LDAPMessageQueue
{
    private com.novell.ldap.LDAPSearchQueue queue;

    /**
     * Constructs a response queue from a com.novell.ldap.LDAPSearchQueue
     */
    /* package */
    LDAPSearchQueue(com.novell.ldap.LDAPSearchQueue queue)
    {
        this.queue = queue;
        return;
    }

    /**
     * Returns a com.novell.ldap.LDAPSearchQueue object
     */
    /* package */
    com.novell.ldap.LDAPSearchQueue getWrappedObject()
    {
        return queue;
    }

   /**
    * Returns the message IDs for all outstanding requests.
    *
    * @see 
            com.novell.ldap.LDAPSearchQueue.getMessageIDs()
    */
    public int[] getMessageIDs()
    {
        return queue.getMessageIDs();
    }

   /**
    * Reports whether a response has been received from the server and
    * not yet retrieved with getResponse.
    *
    * @see 
            com.novell.ldap.LDAPSearchQueue.isResponseReceived()
    */
    public boolean isResponseReceived()
    {
        return queue.isResponseReceived();
    }

   /**
    * Reports whether a response has been received from the server and
    * not yet retrieved with getResponse.
    *
    * @see 
            com.novell.ldap.LDAPSearchQueue.isResponseReceived(int)
    */
    public boolean isResponseReceived(int msgid)
    {
        return queue.isResponseReceived(msgid);
    }

   /**
    * Merges two response queues by moving the contents from another
    * queue to this one.
    *
    * @see 
            com.novell.ldap.LDAPSearchQueue.merge(
            LDAPResponsequeue)
    */
    public void merge(LDAPMessageQueue queue2)
    {
        if( queue2 == null) {
            queue.merge( (com.novell.ldap.LDAPMessageQueue)null);
        }
        if( queue2 instanceof LDAPResponseQueue) {
            queue.merge( ((LDAPResponseQueue)queue2).getWrappedObject());
        } else {
            queue.merge( ((LDAPSearchQueue)queue2).getWrappedObject());
        }
        return;
    }

    /**
     * Reports true if all results have been received for a particular
     * message id.
     *
     * @see 
            com.novell.ldap.LDAPSearchQueue.isComplete(int)
     */
    public boolean isComplete( int msgid )
    {
        return queue.isComplete( msgid);
    }

    /**
     * Blocks until a response is available, or until all operations
     * associated with the object have completed or been canceled, and
     * returns the response.
     *
     * @see 
            com.novell.ldap.LDAPSearchQueue.getResponse()
     */
    public LDAPMessage getResponse()
            throws LDAPException
    {
        try {
            return new LDAPMessage(queue.getResponse());
        } catch( com.novell.ldap.LDAPException ex) {
            if( ex instanceof com.novell.ldap.LDAPReferralException) {
                throw new LDAPReferralException(
                            (com.novell.ldap.LDAPReferralException)ex);
            } else {
                throw new LDAPException( ex);
            }
        }
    }

    /**
     * Blocks until a response is available for a particular message id,
     * or until all operations
     * associated with the object have completed or been canceled, and
     * returns the response.
     *
     * @see 
            com.novell.ldap.LDAPSearchQueue.getResponse(int)
     */
    public LDAPMessage getResponse(int msgid)
            throws LDAPException
    {
        try {
            return new LDAPMessage(queue.getResponse( msgid));
        } catch( com.novell.ldap.LDAPException ex) {
            if( ex instanceof com.novell.ldap.LDAPReferralException) {
                throw new LDAPReferralException(
                        (com.novell.ldap.LDAPReferralException)ex);
            } else {
                throw new LDAPException( ex);
            }
        }
    }
}