org.apache.directory.server.core.api.interceptor.context

Class BindOperationContext

java.lang.Object

org.apache.directory.server.core.api.interceptor.context.AbstractOperationContext

org.apache.directory.server.core.api.interceptor.context.BindOperationContext

All Implemented Interfaces:

OperationContext

public class BindOperationContext
extends AbstractOperationContext

A Bind context used for Interceptors. It contains all the informations needed for the bind operation, and used by all the interceptors

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.server.core.api.interceptor.context.AbstractOperationContext

authorizedPrincipal, byPassed, currentInterceptor, dn, EMPTY_CONTROLS, entry, interceptors, originalEntry, requestControls, responseControls, session, throwReferral

Constructor Summary

Constructors

Constructor and Description
BindOperationContext(CoreSession session) Creates a new instance of BindOperationContext.

Method Summary

Modifier and Type	Method and Description
org.apache.directory.api.ldap.model.constants.AuthenticationLevel	getAuthenticationLevel()
byte[]	getCredentials()
org.apache.mina.core.session.IoSession	getIoSession()
String	getName()
ReferralHandlingMode	getReferralHandlingMode()
String	getSaslAuthId()
String	getSaslMechanism()
void	ignoreReferral() Set the throwReferral flag to false
boolean	isCollateralOperation() Tells if the current operation is considered a side effect of the current context
boolean	isReferralIgnored()
boolean	isReferralThrown()
boolean	isSaslBind()
void	setCollateralOperation(boolean collateralOperation)
void	setCredentials(byte[] credentials)
void	setIoSession(org.apache.mina.core.session.IoSession ioSession)
void	setReferralHandlingMode(ReferralHandlingMode referralHandlingMode)
void	setSaslAuthId(String saslAuthId)
void	setSaslMechanism(String saslMechanism)
void	throwReferral() Set the throwReferral flag to true
String	toString()

Methods inherited from class org.apache.directory.server.core.api.interceptor.context.AbstractOperationContext

addRequestControl, addRequestControls, addResponseControl, delete, getCurrentInterceptor, getDn, getEffectivePrincipal, getEntry, getNextInterceptor, getOriginalEntry, getRequestControl, getResponseControl, getResponseControlCount, getResponseControls, getSession, hasRequestControl, hasRequestControls, hasResponseControl, hasResponseControls, lookup, newLookupContext, setAuthorizedPrincipal, setCurrentInterceptor, setDn, setEntry, setInterceptors, setOriginalEntry, setRequestControls, setSession

Methods inherited from class java.lang.Object

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

Constructor Detail

BindOperationContext

public BindOperationContext(CoreSession session)

Creates a new instance of BindOperationContext.

Method Detail

getAuthenticationLevel

public org.apache.directory.api.ldap.model.constants.AuthenticationLevel getAuthenticationLevel()
                                                                                         throws org.apache.directory.api.ldap.model.exception.LdapAuthenticationException

Returns:

The authentication level. One of :

ANONYMOUS

SIMPLE

STRONG (sasl)

UNAUTHENT

INVALID

Throws:

org.apache.directory.api.ldap.model.exception.LdapAuthenticationException

getSaslMechanism

public String getSaslMechanism()

Returns:

the SASL mechanisms

setSaslMechanism

public void setSaslMechanism(String saslMechanism)

getCredentials

public byte[] getCredentials()

Returns:

The principal password

setCredentials

public void setCredentials(byte[] credentials)

getSaslAuthId

public String getSaslAuthId()

Returns:

The SASL authentication ID

setSaslAuthId

public void setSaslAuthId(String saslAuthId)

isSaslBind

public boolean isSaslBind()

getName

public String getName()

Specified by:

getName in interface OperationContext

Specified by:

getName in class AbstractOperationContext

Returns:

the operation name

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

isCollateralOperation

public boolean isCollateralOperation()

Tells if the current operation is considered a side effect of the current context

setCollateralOperation

public void setCollateralOperation(boolean collateralOperation)

getReferralHandlingMode

public ReferralHandlingMode getReferralHandlingMode()

setReferralHandlingMode

public void setReferralHandlingMode(ReferralHandlingMode referralHandlingMode)

throwReferral

public void throwReferral()

Set the throwReferral flag to true

Specified by:

throwReferral in interface OperationContext

Overrides:

throwReferral in class AbstractOperationContext

isReferralThrown

public boolean isReferralThrown()

Specified by:

isReferralThrown in interface OperationContext

Overrides:

isReferralThrown in class AbstractOperationContext

Returns:

true if the referrals are thrown

ignoreReferral

public void ignoreReferral()

Set the throwReferral flag to false

Specified by:

ignoreReferral in interface OperationContext

Overrides:

ignoreReferral in class AbstractOperationContext

isReferralIgnored

public boolean isReferralIgnored()

Specified by:

isReferralIgnored in interface OperationContext

Overrides:

isReferralIgnored in class AbstractOperationContext

Returns:

true if the referrals are ignored

getIoSession

public org.apache.mina.core.session.IoSession getIoSession()

Returns:

the ioSession

setIoSession

public void setIoSession(org.apache.mina.core.session.IoSession ioSession)

Parameters:

ioSession - the ioSession to set