org.apache.directory.api.dsmlv2.reponse
Class BindResponseDsml

java.lang.Object
  org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator<E>
      org.apache.directory.api.dsmlv2.reponse.AbstractResponseDsml<E>
          org.apache.directory.api.dsmlv2.reponse.AbstractResultResponseDsml<BindResponse>
              org.apache.directory.api.dsmlv2.reponse.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

Field Summary

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

TYPE

Constructor Summary

BindResponseDsml(LdapApiService codec)
Creates a new getDecoratedMessage() of AuthResponseDsml.

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

Method Summary

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.reponse.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

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

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

Constructor Detail

BindResponseDsml

public BindResponseDsml(LdapApiService codec)

Creates a new getDecoratedMessage() of AuthResponseDsml.

BindResponseDsml

public BindResponseDsml(LdapApiService codec,
                        BindResponse ldapMessage)

Creates a new getDecoratedMessage() of AuthResponseDsml.

Parameters:

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>

Specified by:

toDsml in class AbstractResultResponseDsml<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