Class LDAPProxiedAuthControl

java.lang.Object

netscape.ldap.LDAPControl

netscape.ldap.controls.LDAPProxiedAuthControl

All Implemented Interfaces:

Serializable, Cloneable

public class LDAPProxiedAuthControl
extends LDAPControl

Represents an LDAP v3 server control that specifies that you want the server to use the specified DN's identity for this operation. (The OID for this control is 2.16.840.1.113730.3.4.12.)

You can include the control in any request by constructing an LDAPSearchConstraints object and calling the setServerControls method. You can then pass this LDAPSearchConstraints object to the search or other request method of an LDAPConnection object.

For example:

...
LDAPConnection ld = new LDAPConnection();
try {
    // Connect to server.
    ld.connect( 3, hostname, portnumber, "", "" );

    // Create a "critical" proxied auth server control using
    // the DN "uid=charlie,ou=people,o=acme.com".
    LDAPProxiedAuthControl ctrl =
        new LDAPProxiedAuthControl( "uid=charlie,ou=people,o=acme.com",
                                    true );

    // Create search constraints to use that control.
    LDAPSearchConstraints cons = new LDAPSearchConstraints();
    cons.setServerControls( sortCtrl );

    // Send the search request.
    LDAPSearchResults res = ld.search( "o=Airius.com",
       LDAPv3.SCOPE_SUB, "(cn=Barbara*)", null, false, cons );

    ...

Version:

1.0

See Also:

• LDAPControl
• LDAPConstraints
• LDAPSearchConstraints
• LDAPConstraints.setServerControls(LDAPControl)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROXIEDAUTHREQUEST

Fields inherited from class LDAPControl

m_critical, m_value, MANAGEDSAIT, PWEXPIRED, PWEXPIRING

Modifier and Type	Field	Description
protected boolean	m_critical
protected byte[]	m_value
static final String	MANAGEDSAIT
static final String	PWEXPIRED
static final String	PWEXPIRING

Constructor Summary

Constructors

Constructor	Description
LDAPProxiedAuthControl(String dn, boolean critical)	Constructs an LDAPProxiedAuthControl object with a DN to use as identity.

Method Summary

Modifier and Type	Method	Description
String	toString()	Return a string representation of the control for debugging

Methods inherited from class LDAPControl

clone, createControl, flattenBER, getID, getValue, isCritical, lookupControlClass, newInstance, register

Modifier and Type	Method	Description
Object	clone()	Creates a copy of the control.
protected static LDAPControl	createControl(String oid, boolean critical, byte[] value)	Returns a LDAPControl object instantiated by the Class associated by LDAPControl.register to the oid.
protected byte[]	flattenBER(BERSequence ber)	Create a "flattened" BER encoding from a BER, and return it as a byte array.
String	getID()	Gets the object ID (OID) of the control.
byte[]	getValue()	Gets the data in the control.
boolean	isCritical()	Specifies whether or not the control is critical to the LDAP operation.
protected static Class<?>	lookupControlClass(String oid)	Returns the Class that has been registered to oid.
static LDAPControl[]	newInstance(byte[] data)	Instantiates all of the controls contained within the LDAP message fragment specified by data and returns them in an LDAPControl array.
static void	register(String oid, Class<?> controlClass)	Associates a class with an oid.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

PROXIEDAUTHREQUEST

public static final String PROXIEDAUTHREQUEST

See Also:

• Constant Field Values

Constructor Details

LDAPProxiedAuthControl

public LDAPProxiedAuthControl(String dn,
 boolean critical)

Constructs an LDAPProxiedAuthControl object with a DN to use as identity.

Parameters:

dn - DN to use as identity for execution of a request

critical - true if the LDAP operation should be discarded when the server does not support this control (in other words, this control is critical to the LDAP operation)

See Also:

• LDAPControl

Method Details

toString

public String toString()

Description copied from class: LDAPControl

Return a string representation of the control for debugging

Overrides:

toString in class LDAPControl

Returns:

a string representation of the control.