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

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	collateralOperation A flag to tell that this is a collateral operation
private byte[]	credentials The password
private org.apache.mina.core.session.IoSession	ioSession The IoSession if any
private static org.slf4j.Logger	LOG A logger for this class
private ReferralHandlingMode	referralHandlingMode
private java.lang.String	saslAuthId The SASL identifier
private java.lang.String	saslMechanism The SASL mechanism

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()
java.lang.String	getName()
ReferralHandlingMode	getReferralHandlingMode()
java.lang.String	getSaslAuthId()
java.lang.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(java.lang.String saslAuthId)
void	setSaslMechanism(java.lang.String saslMechanism)
void	throwReferral() Set the throwReferral flag to true
java.lang.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

Field Detail

LOG

private static final org.slf4j.Logger LOG

A logger for this class

credentials

private byte[] credentials

The password

saslMechanism

private java.lang.String saslMechanism

The SASL mechanism

saslAuthId

private java.lang.String saslAuthId

The SASL identifier

collateralOperation

private boolean collateralOperation

A flag to tell that this is a collateral operation

referralHandlingMode

private ReferralHandlingMode referralHandlingMode

ioSession

private org.apache.mina.core.session.IoSession ioSession

The IoSession if any

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 java.lang.String getSaslMechanism()

Returns:

the SASL mechanisms

setSaslMechanism

public void setSaslMechanism(java.lang.String saslMechanism)

getCredentials

public byte[] getCredentials()

Returns:

The principal password

setCredentials

public void setCredentials(byte[] credentials)

getSaslAuthId

public java.lang.String getSaslAuthId()

Returns:

The SASL authentication ID

setSaslAuthId

public void setSaslAuthId(java.lang.String saslAuthId)

isSaslBind

public boolean isSaslBind()

getName

public java.lang.String getName()

Specified by:

getName in interface OperationContext

Specified by:

getName in class AbstractOperationContext

Returns:

the operation name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.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