oracle.oud.requests

Class BindRequestWrapper

java.lang.Object

oracle.oud.requests.BindRequestWrapper

All Implemented Interfaces:

AttachmentHolder, BindRequest, Request

public class BindRequestWrapper
extends java.lang.Object
implements BindRequest

This class wraps a Bind request.

Constructor Summary

Constructors

Constructor and Description
BindRequestWrapper(BindRequest request) Creates a new BindRequestWrapper that wraps the specified bind request.

Method Summary

Modifier and Type	Method and Description
BindRequest	addControl(Control control) Adds the provided control to this request.
java.lang.Object	getAttachment(java.lang.String name) Retrieves the attachment with the specified name.
java.util.Set<java.lang.String>	getAttachmentNames() Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object.
byte	getAuthenticationType() Returns the authentication mechanism identifier for this generic bind request as defined by the LDAP protocol.
<C extends Control> C	getControl(ControlDecoder<C> decoder) Decodes and returns the first control in this request having an OID corresponding to the provided control decoder.
java.util.List<Control>	getControls() Returns a List containing the controls included with this request.
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.
boolean	isInternal() Returns true if this request is flagged as internal; false otherwise.
java.lang.Object	removeAttachment(java.lang.String name) Removes the attachment with the specified name.
Request	removeControl(Control control) Removes the provided control from this request.
java.lang.Object	setAttachment(java.lang.String name, java.lang.Object value) Sets the value of the specified attachment.
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 class java.lang.Object

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

Methods inherited from interface oracle.oud.requests.Request

getControl, getControls, isInternal, removeControl

Methods inherited from interface oracle.oud.plugin.AttachmentHolder

getAttachment, getAttachmentNames, removeAttachment, setAttachment

Constructor Detail

BindRequestWrapper

public BindRequestWrapper(BindRequest request)

Creates a new BindRequestWrapper that wraps the specified bind request.

Parameters:

request - the request to wrap.

Method Detail

addControl

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

Description copied from interface: Request

Adds the provided control to this request.

Specified by:

addControl in interface BindRequest

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

public byte getAuthenticationType()

Description copied from interface: BindRequest

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.

Specified by:

getAuthenticationType in interface BindRequest

Returns:

The authentication mechanism identifier.

getPassword

public ByteString getPassword()

Description copied from interface: BindRequest

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.

Specified by:

getPassword in interface BindRequest

Returns:

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

getName

public DN getName()

Description copied from interface: BindRequest

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.

Specified by:

getName in interface BindRequest

Returns:

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

setName

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

Description copied from interface: BindRequest

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.

Specified by:

setName in interface BindRequest

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

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

Description copied from interface: BindRequest

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.

Specified by:

setName in interface BindRequest

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

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

Description copied from interface: BindRequest

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.

Specified by:

setPassword in interface BindRequest

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

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

Description copied from interface: BindRequest

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.

Specified by:

setPassword in interface BindRequest

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.

getControl

public <C extends Control> C getControl(ControlDecoder<C> decoder)
                                 throws java.lang.NullPointerException,
                                        PluginException

Description copied from interface: Request

Decodes and returns the first control in this request having an OID corresponding to the provided control decoder.

Specified by:

getControl in interface Request

Type Parameters:

C - The type of control to be decoded and returned.

Parameters:

decoder - The control decoder.

Returns:

The decoded control, or null if the control is not included with this request.

Throws:

java.lang.NullPointerException - If decoder was null.

PluginException - If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).

getControls

public java.util.List<Control> getControls()

Description copied from interface: Request

Returns a List containing the controls included with this request. The returned List is immutable.

Specified by:

getControls in interface Request

Returns:

A List containing the controls.

removeControl

public Request removeControl(Control control)
                      throws java.lang.UnsupportedOperationException,
                             java.lang.NullPointerException

Description copied from interface: Request

Removes the provided control from this request.

Specified by:

removeControl in interface Request

Parameters:

control - The control to be removed from this request.

Returns:

This request.

Throws:

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

java.lang.NullPointerException - If control was null.

removeAttachment

public java.lang.Object removeAttachment(java.lang.String name)

Description copied from interface: AttachmentHolder

Removes the attachment with the specified name.

Specified by:

removeAttachment in interface AttachmentHolder

Parameters:

name - The name for the attachment to remove. It will be treated in a case-sensitive manner.

Returns:

The attachment that was removed, or null if it does not exist.

setAttachment

public java.lang.Object setAttachment(java.lang.String name,
                                      java.lang.Object value)

Description copied from interface: AttachmentHolder

Sets the value of the specified attachment. If an attachment already exists with the same name, it will be replaced. Otherwise, a new attachment will be added.

Specified by:

setAttachment in interface AttachmentHolder

Parameters:

name - The name to use for the attachment.

value - The value to use for the attachment.

Returns:

The former value held by the attachment with the given name, or null if there was previously no such attachment.

getAttachment

public java.lang.Object getAttachment(java.lang.String name)

Description copied from interface: AttachmentHolder

Retrieves the attachment with the specified name.

Specified by:

getAttachment in interface AttachmentHolder

Parameters:

name - The name for the attachment to retrieve. It will be treated in a case-sensitive manner.

Returns:

The requested attachment object, or null if it does not exist.

getAttachmentNames

public java.util.Set<java.lang.String> getAttachmentNames()

Description copied from interface: AttachmentHolder

Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object.

Specified by:

getAttachmentNames in interface AttachmentHolder

Returns:

The set of attachments defined for this request.

isInternal

public boolean isInternal()

Description copied from interface: Request

Returns true if this request is flagged as internal; false otherwise.

When a request is flagged internal, various components of the server may behave in a manner that is less restrictive. For example, attributes defined as NO-USER-MODIFICATION are allowed to be added, private backends are accessible, ...

Specified by:

isInternal in interface Request

Returns:

true if this request is flagged as internal; false otherwise.