Package org.apache.directory.api.dsmlv2.response

Class BindResponseDsml

java.lang.Object

org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator<E>

org.apache.directory.api.dsmlv2.response.AbstractResponseDsml<E>

org.apache.directory.api.dsmlv2.response.AbstractResultResponseDsml<BindResponse>

org.apache.directory.api.dsmlv2.response.BindResponseDsml

All Implemented Interfaces:

DsmlDecorator<BindResponse>, BindResponse, Message, Response, ResultResponse

public class BindResponseDsml
extends AbstractResultResponseDsml<BindResponse>
implements BindResponse

DSML Decorator for AuthResponse

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
BindResponseDsml(LdapApiService codec)	Creates a new getDecoratedMessage() of AuthResponseDsml.
BindResponseDsml(LdapApiService codec, BindResponse ldapMessage)	Creates a new getDecoratedMessage() of AuthResponseDsml.

Method Summary

Modifier and Type	Method	Description
byte[]	getServerSaslCreds()	Gets the optional property holding SASL authentication response parameters that are SASL mechanism specific.
void	setServerSaslCreds(byte[] serverSaslCreds)	Sets the optional property holding SASL authentication response paramters that are SASL mechanism specific.
org.dom4j.Element	toDsml(org.dom4j.Element root)	Converts the request/reponse to its XML representation in the DSMLv2 format

Methods inherited from class org.apache.directory.api.dsmlv2.response.AbstractResultResponseDsml

getLdapResult

Methods inherited from class org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

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

getLdapResult

Constructor Detail

BindResponseDsml

public BindResponseDsml(LdapApiService codec)

Creates a new getDecoratedMessage() of AuthResponseDsml.

Parameters:

codec - The LDAP Service to use

BindResponseDsml

public BindResponseDsml(LdapApiService codec,
                        BindResponse ldapMessage)

Creates a new getDecoratedMessage() of AuthResponseDsml.

Parameters:

codec - The LDAP Service to use

ldapMessage - the message to decorate

Method Detail

toDsml

public org.dom4j.Element toDsml(org.dom4j.Element root)

Converts the request/reponse to its XML representation in the DSMLv2 format

Specified by:

toDsml in interface DsmlDecorator<BindResponse>

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.

getServerSaslCreds

public byte[] getServerSaslCreds()

Gets the optional property holding SASL authentication response parameters that are SASL mechanism specific. Will return null if the authentication is simple.

Specified by:

getServerSaslCreds in interface BindResponse

Returns:

the sasl mech. specific credentials or null of auth. is simple

setServerSaslCreds

public void setServerSaslCreds(byte[] serverSaslCreds)

Sets the optional property holding SASL authentication response paramters that are SASL mechanism specific. Leave null if authentication mode is simple.

Specified by:

setServerSaslCreds in interface BindResponse

Parameters:

serverSaslCreds - the sasl auth. mech. specific credentials