org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI

Class WhoAmIResponseDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.MessageDecorator<M>

org.apache.directory.api.ldap.codec.decorators.ResponseDecorator<R>

org.apache.directory.api.ldap.codec.api.ExtendedResponseDecorator<WhoAmIResponse>

org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI.WhoAmIResponseDecorator

All Implemented Interfaces:

Asn1Object, Decorator<WhoAmIResponse>, WhoAmIResponse, ExtendedResponse, Message, Response, ResultResponse

public class WhoAmIResponseDecorator
extends ExtendedResponseDecorator<WhoAmIResponse>
implements WhoAmIResponse

A Decorator for WhoAmIResponse extended request.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG
private WhoAmIResponse	whoAmIResponse

Fields inherited from class org.apache.directory.api.ldap.codec.api.ExtendedResponseDecorator

responseValue

Fields inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

messageLength

Fields inherited from interface org.apache.directory.api.ldap.extras.extended.whoAmI.WhoAmIResponse

EXTENSION_OID

Fields inherited from interface org.apache.directory.api.ldap.model.message.ExtendedResponse

TYPE

Constructor Summary

Constructors

Constructor and Description
WhoAmIResponseDecorator(LdapApiService codec, WhoAmIResponse decoratedMessage)

Method Summary

Modifier and Type	Method and Description
(package private) int	computeLengthInternal() Compute the WhoAmIResponse extended operation length
(package private) java.nio.ByteBuffer	encodeInternal() Encodes the WhoAmIResponse extended operation.
byte[]	getAuthzId() Get the authzid as a byte[]
java.lang.String	getAuthzIdString() Get the authzid as String.
Dn	getDn() Get the DN authzid.
java.lang.String	getResponseName() Overload the parent's getResponseName method, as the WhoAmI response should not contain the responseName.
byte[]	getResponseValue()
java.lang.String	getUserId() Get the UserId
boolean	isDnAuthzId()
boolean	isUserAuthzId()
void	setAuthzId(byte[] authzId) set the authzid
(package private) void	setDn(Dn dn) Set the DnId
void	setResponseValue(byte[] responseValue)
(package private) void	setUserId(java.lang.String userId) Set the userId

Methods inherited from class org.apache.directory.api.ldap.codec.api.ExtendedResponseDecorator

computeLength, encode, setResponseName

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.ResponseDecorator

getLdapResult, setLdapResult

Methods inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

addAllControls, addControl, get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, removeControl, setControlsLength, setMessageId, setMessageLength, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.api.ldap.model.message.ExtendedResponse

setResponseName

Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponse

getLdapResult

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Field Detail

LOG

private static final org.slf4j.Logger LOG

whoAmIResponse

private WhoAmIResponse whoAmIResponse

Constructor Detail

WhoAmIResponseDecorator

public WhoAmIResponseDecorator(LdapApiService codec,
                               WhoAmIResponse decoratedMessage)

Method Detail

setResponseValue

public void setResponseValue(byte[] responseValue)

Overrides:

setResponseValue in class ExtendedResponseDecorator<WhoAmIResponse>

getResponseValue

public byte[] getResponseValue()

Overrides:

getResponseValue in class ExtendedResponseDecorator<WhoAmIResponse>

getAuthzId

public byte[] getAuthzId()

Get the authzid as a byte[]

Specified by:

getAuthzId in interface WhoAmIResponse

Returns:

The authzid or null

setAuthzId

public void setAuthzId(byte[] authzId)

set the authzid

Specified by:

setAuthzId in interface WhoAmIResponse

setUserId

void setUserId(java.lang.String userId)

Set the userId

setDn

void setDn(Dn dn)

Set the DnId

isDnAuthzId

public boolean isDnAuthzId()

Specified by:

isDnAuthzId in interface WhoAmIResponse

Returns:

true if the response contains a DN authz (dn:XXX)

isUserAuthzId

public boolean isUserAuthzId()

Specified by:

isUserAuthzId in interface WhoAmIResponse

Returns:

true if the response contains a userID authz (u:XXX)

getAuthzIdString

public java.lang.String getAuthzIdString()

Get the authzid as String. We will strip out the 'dn:' or 'u:' part.

Specified by:

getAuthzIdString in interface WhoAmIResponse

Returns:

The authzid or null

getUserId

public java.lang.String getUserId()

Get the UserId

Specified by:

getUserId in interface WhoAmIResponse

Returns:

The userId or null

getDn

public Dn getDn()

Get the DN authzid.

Specified by:

getDn in interface WhoAmIResponse

Returns:

The DN or null

getResponseName

public java.lang.String getResponseName()

Overload the parent's getResponseName method, as the WhoAmI response should not contain the responseName.

Specified by:

getResponseName in interface ExtendedResponse

Overrides:

getResponseName in class ExtendedResponseDecorator<WhoAmIResponse>

Returns:

the OID of the extended response type.

computeLengthInternal

int computeLengthInternal()

Compute the WhoAmIResponse extended operation length

 0x04 L1 authzId
 

encodeInternal

java.nio.ByteBuffer encodeInternal()
                            throws EncoderException

Encodes the WhoAmIResponse extended operation.

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

EncoderException - If anything goes wrong.