Package org.ldaptive.extended

Class ExtendedResponse

java.lang.Object

org.ldaptive.AbstractMessage

org.ldaptive.AbstractResult

org.ldaptive.extended.ExtendedResponse

All Implemented Interfaces:

Message, Result

Direct Known Subclasses:

UnsolicitedNotification

public class ExtendedResponse
extends AbstractResult

LDAP extended response defined as:

   ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
     COMPONENTS OF LDAPResult,
     responseName     [10] LDAPOID OPTIONAL,
     responseValue    [11] OCTET STRING OPTIONAL }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtendedResponse.Builder
protected static class	ExtendedResponse.ResponseNameHandler	Parse handler implementation for the response name.
protected static class	ExtendedResponse.ResponseValueHandler	Parse handler implementation for the response value.

Nested classes/interfaces inherited from class org.ldaptive.AbstractResult

AbstractResult.AbstractBuilder<B,T extends AbstractResult>, AbstractResult.DiagnosticMessageHandler, AbstractResult.MatchedDNHandler, AbstractResult.ReferralHandler, AbstractResult.ResultCodeHandler

Nested classes/interfaces inherited from class org.ldaptive.AbstractMessage

AbstractMessage.ControlParser, AbstractMessage.ControlsHandler, AbstractMessage.MessageIDHandler

Field Summary

Fields

Modifier and Type	Field	Description
private static DERPath	DIAGNOSTIC_MESSAGE_PATH	DER path to diagnostic message.
private static int	HASH_CODE_SEED	hash code seed.
private static DERPath	MATCHED_DN_PATH	DER path to matched DN.
private static DERPath	NAME_PATH	DER path to name.
static int	PROTOCOL_OP	BER protocol number.
private static DERPath	REFERRAL_PATH	DER path to referral.
private String	responseName	Response name.
private byte[]	responseValue	Response value.
private static DERPath	RESULT_CODE_PATH	DER path to result code.
private static DERPath	VALUE_PATH	DER path to value.

Fields inherited from interface org.ldaptive.Result

ENCODE_CNTRL_CHARS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExtendedResponse()	Default constructor.
	ExtendedResponse(DERBuffer buffer)	Creates a new extended response.

Method Summary

Modifier and Type	Method	Description
static ExtendedResponse.Builder	builder()	Creates a builder for this class.
boolean	equals(Object o)
String	getResponseName()
byte[]	getResponseValue()
int	hashCode()	Returns the hash code for this object.
protected void	setResponseName(String name)
protected void	setResponseValue(byte[] value)
String	toString()

Methods inherited from class org.ldaptive.AbstractResult

addReferralURLs, copyValues, equalsResult, getDiagnosticMessage, getMatchedDN, getReferralURLs, getResultCode, setDiagnosticMessage, setMatchedDN, setResultCode

Methods inherited from class org.ldaptive.AbstractMessage

addControls, copyValues, equalsMessage, getControls, getMessageID, setMessageID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ldaptive.Message

getControl, getControls, getMessageID

Methods inherited from interface org.ldaptive.Result

getEncodedDiagnosticMessage, isSuccess

Field Detail

PROTOCOL_OP

public static final int PROTOCOL_OP

BER protocol number.

See Also:

Constant Field Values

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

RESULT_CODE_PATH

private static final DERPath RESULT_CODE_PATH

DER path to result code.

MATCHED_DN_PATH

private static final DERPath MATCHED_DN_PATH

DER path to matched DN.

DIAGNOSTIC_MESSAGE_PATH

private static final DERPath DIAGNOSTIC_MESSAGE_PATH

DER path to diagnostic message.

REFERRAL_PATH

private static final DERPath REFERRAL_PATH

DER path to referral.

NAME_PATH

private static final DERPath NAME_PATH

DER path to name.

VALUE_PATH

private static final DERPath VALUE_PATH

DER path to value.

responseName

private String responseName

Response name.

responseValue

private byte[] responseValue

Response value.

Constructor Detail

ExtendedResponse

protected ExtendedResponse()

Default constructor.

ExtendedResponse

public ExtendedResponse(DERBuffer buffer)

Creates a new extended response.

Parameters:

buffer - to decode

Method Detail

getResponseName

public final String getResponseName()

setResponseName

protected final void setResponseName(String name)

getResponseValue

public final byte[] getResponseValue()

setResponseValue

protected final void setResponseValue(byte[] value)

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractResult

hashCode

public int hashCode()

Description copied from class: AbstractMessage

Returns the hash code for this object.

Specified by:

hashCode in class AbstractMessage

Returns:

hash code

toString

public String toString()

Overrides:

toString in class AbstractResult

builder

public static ExtendedResponse.Builder builder()

Creates a builder for this class.

Returns:

new builder