org.forgerock.opendj.ldap.messages

Class UnknownRequest

java.lang.Object

org.forgerock.opendj.ldap.messages.UnknownRequest

All Implemented Interfaces:

ProtocolOp, Request

public final class UnknownRequest
extends Object
implements Request

Wraps a message that the LdapServer was unable to decode because it did not recognize it.

Nested Class Summary

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

Request.RequestType

Method Summary

Modifier and Type	Method and Description
<R,P,E extends Exception> R	accept(RequestVisitor<R,P,E> v, P p) Applies a RequestVisitor to this Request.
M	addControl(Control control) Adds the provided control to this protocol-op.
M	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.
byte	getProtocolOpType() Returns the LDAP protocol-op type.
ByteString	getRawProtocolOp() Returns the unparsed protocol-op bytes.
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.Request

addControl, addControls

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

containsControl, getControl, getControl, getControls

Method Detail

getProtocolOpType

public byte getProtocolOpType()

Returns the LDAP protocol-op type.

Returns:

The LDAP protocol-op type.

getRawProtocolOp

public ByteString getRawProtocolOp()

Returns the unparsed protocol-op bytes.

Returns:

The unparsed protocol-op bytes.

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()

Description copied from interface: Request

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

Specified by:

getType in interface Request

Returns:

the type of this request

toString

public String toString()

addControl

public final M addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface ProtocolOp

Parameters:

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

Returns:

This protocol-op.

addControls

public final M addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ProtocolOp

Parameters:

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

Returns:

This protocol-op.

containsControl

public final 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.

getControl

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

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.

Throws:

DecodeException - 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 final 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.