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

Class WhoAmIResponseImpl

java.lang.Object

org.apache.directory.api.ldap.model.message.AbstractMessage

org.apache.directory.api.ldap.model.message.AbstractResponse

org.apache.directory.api.ldap.model.message.AbstractResultResponse

org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

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

All Implemented Interfaces:

WhoAmIResponse, org.apache.directory.api.ldap.model.message.ExtendedResponse, org.apache.directory.api.ldap.model.message.Message, org.apache.directory.api.ldap.model.message.Response, org.apache.directory.api.ldap.model.message.ResultResponse

public class WhoAmIResponseImpl
extends org.apache.directory.api.ldap.model.message.AbstractExtendedResponse
implements WhoAmIResponse

The RFC 4532 WhoAmI response :

 authzid OCTET STRING OPTIONAL
 

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	authzId The authzid
private org.apache.directory.api.ldap.model.name.Dn	dn The authzId when it's a DN
private String	userId The authzId when it's a userId

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

responseName

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractResultResponse

ldapResult

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

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

EXTENSION_OID

Constructor Summary

Constructors

Constructor and Description
WhoAmIResponseImpl() Instantiates a new WhoAmI response.
WhoAmIResponseImpl(int messageId) Instantiates a new WhoAmI response.
WhoAmIResponseImpl(int messageId, org.apache.directory.api.ldap.model.message.ResultCodeEnum rcode) Create a new instance for the WhoAmI response
WhoAmIResponseImpl(int messageId, org.apache.directory.api.ldap.model.message.ResultCodeEnum rcode, String diagnosticMessage) Create a new instance for the WhoAmI response

Method Summary

Modifier and Type	Method and Description
byte[]	getAuthzId() Get the authzid as a byte[]
String	getAuthzIdString() Get the authzid as String.
org.apache.directory.api.ldap.model.name.Dn	getDn() Get the DN authzid.
String	getUserId() Get the UserId
boolean	isDnAuthzId()
boolean	isUserAuthzId()
void	setAuthzId(byte[] authzId) Set the authzId value
void	setDn(org.apache.directory.api.ldap.model.name.Dn dn) Set the DN
void	setUserId(String userId) Set the userId
String	toString()

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

equals, getResponseName, hashCode, setResponseName

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractResultResponse

getLdapResult

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

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

Methods inherited from class java.lang.Object

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

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

getResponseName, 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

authzId

private byte[] authzId

The authzid

dn

private org.apache.directory.api.ldap.model.name.Dn dn

The authzId when it's a DN

userId

private String userId

The authzId when it's a userId

Constructor Detail

WhoAmIResponseImpl

public WhoAmIResponseImpl(int messageId,
                          org.apache.directory.api.ldap.model.message.ResultCodeEnum rcode,
                          String diagnosticMessage)

Create a new instance for the WhoAmI response

Parameters:

messageId - The Message ID

rcode - The result code

diagnosticMessage - The diagnostic message

WhoAmIResponseImpl

public WhoAmIResponseImpl(int messageId,
                          org.apache.directory.api.ldap.model.message.ResultCodeEnum rcode)

Create a new instance for the WhoAmI response

Parameters:

messageId - The Message ID

rcode - The result code

WhoAmIResponseImpl

public WhoAmIResponseImpl(int messageId)

Instantiates a new WhoAmI response.

Parameters:

messageId - the message id

WhoAmIResponseImpl

public WhoAmIResponseImpl()

Instantiates a new WhoAmI response.

Method Detail

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 value

Parameters:

authzId - the value to store

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

Get the UserId

Specified by:

getUserId in interface WhoAmIResponse

Returns:

The userId or null

setUserId

public void setUserId(String userId)

Set the userId

Parameters:

userId - The User ID

getDn

public org.apache.directory.api.ldap.model.name.Dn getDn()

Get the DN authzid.

Specified by:

getDn in interface WhoAmIResponse

Returns:

The DN or null

setDn

public void setDn(org.apache.directory.api.ldap.model.name.Dn dn)

Set the DN

Parameters:

dn - The DN to set

toString

public String toString()

Overrides:

toString in class org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

See Also:

Object.toString()