oracle.oud.requests

Interface BindRequest

All Superinterfaces:

AttachmentHolder, Request

All Known Implementing Classes:

BindRequestWrapper

public interface BindRequest
extends Request

The Bind operation allows authentication information to be exchanged between the client and server. The Bind operation should be thought of as the "authenticate" operation.

Creation of Bind requests is provided by newBindRequest(DN, ByteString) and newBindRequest(String, char[])

Method Summary

Modifier and Type	Method and Description
BindRequest	addControl(Control control) Adds the provided control to this request.
byte	getAuthenticationType() Returns the authentication mechanism identifier for this generic bind request as defined by the LDAP protocol.
DN	getName() Returns the name of the Directory object that the client wishes to bind as.
ByteString	getPassword() Returns the password of the Directory object that the client wishes to bind as.
BindRequest	setName(DN dn) Sets the name of the Directory object that the client wishes to bind as.
BindRequest	setName(java.lang.String dn) Sets the name of the Directory object that the client wishes to bind as.
BindRequest	setPassword(ByteString password) Sets the password of the Directory object that the client wishes to bind as.
BindRequest	setPassword(char[] password) Sets the password of the Directory object that the client wishes to bind as.

Methods inherited from interface oracle.oud.requests.Request

getControl, getControls, isInternal, removeControl

Methods inherited from interface oracle.oud.plugin.AttachmentHolder

getAttachment, getAttachmentNames, removeAttachment, setAttachment

Method Detail

addControl

BindRequest addControl(Control control)
                throws java.lang.UnsupportedOperationException,
                       java.lang.NullPointerException

Adds the provided control to this request.

Specified by:

addControl in interface Request

Parameters:

control - The control to be added to this request.

Returns:

This request.

Throws:

java.lang.UnsupportedOperationException - If this request does not permit controls to be added.

java.lang.NullPointerException - If control was null.

getAuthenticationType

byte getAuthenticationType()

Returns the authentication mechanism identifier for this generic bind request as defined by the LDAP protocol. Note that value 0x80 is reserved for simple authentication and 0xA3 is reserved for SASL authentication.

Returns:

The authentication mechanism identifier.

getPassword

ByteString getPassword()

Returns the password of the Directory object that the client wishes to bind as. The password may be empty (but never null) when used for of anonymous or unauthenticated binds.

Returns:

The password of the Directory object that the client wishes to bind as.

getName

DN getName()

Returns the name of the Directory object that the client wishes to bind as. The name may be empty (but never null) when used for of anonymous binds.

Returns:

The name of the Directory object that the client wishes to bind as.

setName

BindRequest setName(DN dn)
             throws java.lang.UnsupportedOperationException,
                    java.lang.NullPointerException

Sets the name of the Directory object that the client wishes to bind as. The name may be empty (but never null when used for of anonymous binds.

Parameters:

dn - The name of the Directory object that the client wishes to bind as.

Returns:

This bind request.

Throws:

java.lang.UnsupportedOperationException - If this bind request does not permit the distinguished name to be set.

java.lang.NullPointerException - If dn was null.

setName

BindRequest setName(java.lang.String dn)
             throws PluginException,
                    java.lang.UnsupportedOperationException,
                    java.lang.NullPointerException

Sets the name of the Directory object that the client wishes to bind as. The name may be empty (but never null when used for of anonymous binds.

Parameters:

dn - The name of the Directory object that the client wishes to bind as.

Returns:

This bind request.

Throws:

PluginException - If dn could not be decoded.

java.lang.UnsupportedOperationException - If this bind request does not permit the distinguished name to be set.

java.lang.NullPointerException - If name was null.

setPassword

BindRequest setPassword(ByteString password)
                 throws java.lang.UnsupportedOperationException,
                        java.lang.NullPointerException

Sets the password of the Directory object that the client wishes to bind as. The password may be empty (but never null) when used for of anonymous or unauthenticated binds.

Parameters:

password - The password of the Directory object that the client wishes to bind as, which may be empty.

Returns:

This simple bind request.

Throws:

java.lang.UnsupportedOperationException - If this simple bind request does not permit the password to be set.

java.lang.NullPointerException - If password was null.

setPassword

BindRequest setPassword(char[] password)
                 throws java.lang.UnsupportedOperationException,
                        java.lang.NullPointerException

Sets the password of the Directory object that the client wishes to bind as. The password will be converted to a UTF-8 octet string. The password may be empty (but never null) when used for of anonymous or unauthenticated binds. Subsequent modifications to the password array will not alter this bind request.

Parameters:

password - The password of the Directory object that the client wishes to bind as, which may be empty.

Returns:

This simple bind request.

Throws:

java.lang.UnsupportedOperationException - If this simple bind request does not permit the password to be set.

java.lang.NullPointerException - If password was null.