Package org.forgerock.opendj.ldap.messages

Class InvalidRequest

java.lang.Object

org.forgerock.opendj.ldap.messages.InvalidRequest

All Implemented Interfaces:

ProtocolOp, Request

public final class InvalidRequest
extends Object
implements Request

Represents a request which has been received and decoded but but is invalid according to the LDAP standard because of an invalid DN syntax or an invalid attribute syntax.

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.opendj.ldap.messages.Request

Request.RequestType

Method Summary

Modifier and Type	Method	Description
<R,P,E extends Exception> R	accept(RequestVisitor<R,P,E> v, P p)	Applies a RequestVisitor to this Request.
InvalidRequest	addControl(Control control)	Adds the provided control to this protocol-op.
InvalidRequest	addControls(Iterable<? extends Control> controls)	Adds the provided controls to this protocol-op.
boolean	containsControl(String oid)	Returns true if this protocol-op contains the specified control.
<C extends Control> C	getControl(ControlDecoder<C> decoder, DecodeOptions options)	Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.
List<Control>	getControls()	Returns a List containing the controls included with this protocol-op.
Request.RequestType	getInvalidRequestType()	Returns the LDAP protocol-op type of this request.
String	getRawDn()	Returns the unparsed DN.
LdapException	getReason()	Returns the reason why this request is invalid.
Request.RequestType	getType()	Returns the type of this request to avoid expensive instanceof checks.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp

getControl

Method Detail

getInvalidRequestType

public Request.RequestType getInvalidRequestType()

Returns the LDAP protocol-op type of this request.

Returns:

the LDAP protocol-op type

getRawDn

public String getRawDn()

Returns the unparsed DN.

Returns:

A raw representation of the DN. May be {code null} if the request has no DN.

getReason

public LdapException getReason()

Returns the reason why this request is invalid.

Returns:

The reason for which this request is invalid.

accept

public <R,P,E extends Exception> R accept(RequestVisitor<R,P,E> v,
                                                      P p)
                                               throws E extends Exception

Description copied from interface: Request

Applies a RequestVisitor to this Request.

Specified by:

accept in interface Request

Type Parameters:

R - The return type of the visitor's methods.

P - The type of the additional parameters to the visitor's methods.

E - The type of the exception thrown by the visitor method if it fails, or NeverThrowsException if the visitor cannot fail.

Parameters:

v - The request visitor.

p - Optional additional visitor parameter.

Returns:

A result as specified by the visitor.

Throws:

E - If the visitor failed.

E extends Exception

getType

public Request.RequestType getType()

Returns the type of this request to avoid expensive instanceof checks.

Specified by:

getType in interface Request

Returns:

Always Request.RequestType.INVALID.

See Also:

getInvalidRequestType()

getControl

public <C extends Control> C getControl(ControlDecoder<C> decoder,
                                        DecodeOptions options)

Description copied from interface: ProtocolOp

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

Specified by:

getControl in interface ProtocolOp

Type Parameters:

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

Parameters:

decoder - The control decoder.

options - The set of decode options which should be used when decoding the control.

Returns:

The decoded control, or null if the control is not included with this protocol-op.

getControls

public List<Control> getControls()

Description copied from interface: ProtocolOp

Returns a List containing the controls included with this protocol-op. The returned List may be modified if permitted by this protocol-op.

Specified by:

getControls in interface ProtocolOp

Returns:

A List containing the controls.

containsControl

public boolean containsControl(String oid)

Description copied from interface: ProtocolOp

Returns true if this protocol-op contains the specified control.

Specified by:

containsControl in interface ProtocolOp

Parameters:

oid - The numeric OID of the protocol-op control.

Returns:

true if this protocol-op contains the specified control.

addControl

public InvalidRequest addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface ProtocolOp

Specified by:

addControl in interface Request

Parameters:

control - The control to be added to this protocol-op.

Returns:

This protocol-op.

addControls

public InvalidRequest addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ProtocolOp

Specified by:

addControls in interface Request

Parameters:

controls - The controls to be added to this protocol-op.

Returns:

This protocol-op.

toString

public String toString()

Overrides:

toString in class Object