com.novell.ldap.client.RespControlVector 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/com/novell/ldap/client/RespControlVector.java,v 1.10 2002/09/13 22:00:30 vtag 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 com.novell.ldap.client;

import com.novell.ldap.client.Debug;

/**
 * The MessageVector class implements extends the
 * existing Vector class so that it can be used to maintain a
 * list of currently registered control responses.
 */
public class RespControlVector extends java.util.Vector
{
    public RespControlVector( int cap, int incr)
    {
        super( cap, incr);
        return;
    }

    /** Inner class defined to create a temporary object to encapsulate
     * all registration information about a response control.  This class
     * cannot be used outside this class */
    private class RegisteredControl
    {
        public String myOID;
        public Class myClass;

        public RegisteredControl(String oid, Class controlClass)
        {
            myOID = oid;
            myClass = controlClass;
        }

    }

    /* Adds a control to the current list of registered response controls.
     *
     */
    public final synchronized void registerResponseControl(String oid, Class controlClass)
    {
        if( Debug.LDAP_DEBUG) {
            Debug.trace( Debug.controls, "Registered Control with OID " + oid
                    + " for class " + controlClass.toString());
        }

        addElement(new RegisteredControl(oid, controlClass));
    }

    /* Searches the list of registered controls for a mathcing control.  We
     * search using the OID string.  If a match is found we return the
     * Class name that was provided to us on registration.
     */
    public final synchronized Class findResponseControl(String searchOID)
                throws NoSuchFieldException
    {
        RegisteredControl ctl = null;

        /* loop through the contents of the vector */
        for( int i = 0; i < elementCount; i++) {

            /* Get next registered control */
            if( (ctl = (RegisteredControl)elementData[i]) == null) {
                throw new NoSuchFieldException();
            }

            /* Does the stored OID match with whate we are looking for */
            if(ctl.myOID.compareTo(searchOID) == 0) {

                if( Debug.LDAP_DEBUG) {
                    Debug.trace( Debug.controls, "Returned control matched a registered control");
                }

                /* Return the class name if we have match */
                return ctl.myClass;
            }
        }
        /* The requested control does not have a registered response class */
		if( Debug.LDAP_DEBUG) {
			Debug.trace( Debug.controls, "Returned control did not match any registered control. Treating as ordinary LDAPControl.");
        }
        return null;
    }

 }