org.apache.directory.ldap.client.api
Class SaslRequest

java.lang.Object
  org.apache.directory.ldap.client.api.SaslRequest

Direct Known Subclasses:

CramMd5Request, DigestMd5Request, GssApiRequest

public abstract class SaslRequest
extends Object

Holds the data required to complete the SASL operation

Author:

Apache Directory Project

Field Summary

protected String	authorizationId The authorization ID of the entity
protected List<org.apache.directory.api.ldap.model.message.Control>	controls The list of controls
protected byte[]	credentials The credentials
protected boolean	mutualAuthentication Require mutual authentication
protected org.apache.directory.api.ldap.model.constants.SaslQoP	qualityOfProtection The quality of protection
protected String	realmName The realm name on the server
protected String	saslMechanism The mechanism used to decode user identity
protected org.apache.directory.api.ldap.model.constants.SaslSecurityStrength	securityStrength The security strength
protected String	username The username

Constructor Summary

protected

SaslRequest(String saslMechanism) Creates a new instance of SaslRequest.

Method Summary

void	addAllControls(org.apache.directory.api.ldap.model.message.Control[] controls) Adds the given controls.
void	addControl(org.apache.directory.api.ldap.model.message.Control control) Adds the given control.
String	getAuthorizationId() Gets the authorization ID.
org.apache.directory.api.ldap.model.message.Control[]	getControls() Gets the controls.
byte[]	getCredentials() Gets the crendentials
org.apache.directory.api.ldap.model.constants.SaslQoP	getQualityOfProtection() Gets the quality of protection.
String	getRealmName() Gets realm name.
String	getSaslMechanism() Gets the SASL mechanism.
org.apache.directory.api.ldap.model.constants.SaslSecurityStrength	getSecurityStrength() Gets the security strength.
String	getUsername() Gets the username.
boolean	isMutualAuthentication() Indicates if mutual authentication is required.
void	setAuthorizationId(String authorizationId) Sets the Authorization ID
void	setCredentials(byte[] credentials) Sets the credentials.
void	setCredentials(String credentials) Sets the credentials.
void	setMutualAuthentication(boolean mutualAuthentication) Sets the flag indicating if mutual authentication is required.
void	setQualityOfProtection(org.apache.directory.api.ldap.model.constants.SaslQoP qualityOfProtection) Sets the quality of protection.
protected void	setRealmName(String realmName) Sets the realm name.
protected void	setSaslMechanism(String saslMechanism) Sets the SASL mechanism
void	setSecurityStrength(org.apache.directory.api.ldap.model.constants.SaslSecurityStrength securityStrength) Sets the security strength.
void	setUsername(String username) Sets the username.

Methods inherited from class java.lang.Object

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

Field Detail

saslMechanism

protected String saslMechanism

The mechanism used to decode user identity

controls

protected List<org.apache.directory.api.ldap.model.message.Control> controls

The list of controls

username

protected String username

The username

credentials

protected byte[] credentials

The credentials

realmName

protected String realmName

The realm name on the server

authorizationId

protected String authorizationId

The authorization ID of the entity

qualityOfProtection

protected org.apache.directory.api.ldap.model.constants.SaslQoP qualityOfProtection

The quality of protection

securityStrength

protected org.apache.directory.api.ldap.model.constants.SaslSecurityStrength securityStrength

The security strength

mutualAuthentication

protected boolean mutualAuthentication

Require mutual authentication

Constructor Detail

SaslRequest

protected SaslRequest(String saslMechanism)

Creates a new instance of SaslRequest.

Parameters:

saslMechanism - the SASL mechanism

Method Detail

addAllControls

public void addAllControls(org.apache.directory.api.ldap.model.message.Control[] controls)

Adds the given controls.

Parameters:

controls - the controls

addControl

public void addControl(org.apache.directory.api.ldap.model.message.Control control)

Adds the given control.

Parameters:

control - the control

getAuthorizationId

public String getAuthorizationId()

Gets the authorization ID.

Returns:

the authorization ID

getControls

public org.apache.directory.api.ldap.model.message.Control[] getControls()

Gets the controls.

Returns:

the controls

getCredentials

public byte[] getCredentials()

Gets the crendentials

Returns:

the credentials

getQualityOfProtection

public org.apache.directory.api.ldap.model.constants.SaslQoP getQualityOfProtection()

Gets the quality of protection.

Returns:

the quality of protection

getRealmName

public String getRealmName()

Gets realm name.

Returns:

the realm name

getSaslMechanism

public String getSaslMechanism()

Gets the SASL mechanism.

Returns:

the SASL mechanism

getSecurityStrength

public org.apache.directory.api.ldap.model.constants.SaslSecurityStrength getSecurityStrength()

Gets the security strength.

Returns:

the security strength

getUsername

public String getUsername()

Gets the username.

Returns:

the username

isMutualAuthentication

public boolean isMutualAuthentication()

Indicates if mutual authentication is required.

Returns:

the flag indicating if mutual authentication is required

setAuthorizationId

public void setAuthorizationId(String authorizationId)

Sets the Authorization ID

Parameters:

authorizationId - The authorization ID

setCredentials

public void setCredentials(byte[] credentials)

Sets the credentials.

Parameters:

credentials - the credentials

setCredentials

public void setCredentials(String credentials)

Sets the credentials.

Parameters:

credentials - the credentials

setMutualAuthentication

public void setMutualAuthentication(boolean mutualAuthentication)

Sets the flag indicating if mutual authentication is required.

Parameters:

mutualAuthentication - the flag indicating if mutual authentication is required

setQualityOfProtection

public void setQualityOfProtection(org.apache.directory.api.ldap.model.constants.SaslQoP qualityOfProtection)

Sets the quality of protection.

Parameters:

qualityOfProtection - the quality of protection

setRealmName

protected void setRealmName(String realmName)

Sets the realm name.

Parameters:

realmName - The realm name

setSaslMechanism

protected void setSaslMechanism(String saslMechanism)

Sets the SASL mechanism

Parameters:

saslMechanism - the SASL mechanism

setSecurityStrength

public void setSecurityStrength(org.apache.directory.api.ldap.model.constants.SaslSecurityStrength securityStrength)

Sets the security strength.

Parameters:

securityStrength - the security strength

setUsername

public void setUsername(String username)

Sets the username.

Parameters:

username - the username