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

Class AbstractOperationContext

java.lang.Object

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

All Implemented Interfaces:

OperationContext

Direct Known Subclasses:

AbstractChangeOperationContext, BindOperationContext, CompareOperationContext, EmptyOperationContext, FilteringOperationContext, GetRootDseOperationContext, HasEntryOperationContext, UnbindOperationContext

public abstract class AbstractOperationContext
extends Object
implements OperationContext

This abstract class stores common context elements, like the Dn, which is used in all the contexts.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected LdapPrincipal	authorizedPrincipal
protected Collection<String>	byPassed the Interceptors bypassed by this operation
protected int	currentInterceptor The current interceptor position
protected org.apache.directory.api.ldap.model.name.Dn	dn The Dn associated with the context
protected static org.apache.directory.api.ldap.model.message.Control[]	EMPTY_CONTROLS
protected org.apache.directory.api.ldap.model.entry.Entry	entry The entry associated with the target entry of this OperationContext
protected List<String>	interceptors The interceptors to call for this operation
protected org.apache.directory.api.ldap.model.entry.Entry	originalEntry The original Entry
protected Map<String,org.apache.directory.api.ldap.model.message.Control>	requestControls The associated request's controls
protected Map<String,org.apache.directory.api.ldap.model.message.Control>	responseControls The associated response's controls
protected CoreSession	session The core session
protected boolean	throwReferral A flag used to tell if we should consider referrals as standard entries

Constructor Summary

Constructors

Constructor and Description
AbstractOperationContext(CoreSession session) Creates a new instance of AbstractOperationContext.
AbstractOperationContext(CoreSession session, org.apache.directory.api.ldap.model.name.Dn dn) Creates a new instance of AbstractOperationContext.

Method Summary

Modifier and Type	Method and Description
void	addRequestControl(org.apache.directory.api.ldap.model.message.Control requestControl) Adds a request control to this operation.
void	addRequestControls(org.apache.directory.api.ldap.model.message.Control[] requestControls) Adds many request controls to this operation.
void	addResponseControl(org.apache.directory.api.ldap.model.message.Control responseControl) Adds a response control to this operation.
void	delete(org.apache.directory.api.ldap.model.name.Dn dn) Process the delete for inner operations.
int	getCurrentInterceptor()
org.apache.directory.api.ldap.model.name.Dn	getDn()
LdapPrincipal	getEffectivePrincipal() Gets the effective principal for this operation which may not be the same as the authenticated principal when the session for this context has an explicit authorization id, or this operation was applied with the proxy authorization control.
org.apache.directory.api.ldap.model.entry.Entry	getEntry() Gets the server entry associated with the target Dn of this OperationContext.
abstract String	getName()
String	getNextInterceptor() Gets the next interceptor in the list of interceptors.
org.apache.directory.api.ldap.model.entry.Entry	getOriginalEntry()
org.apache.directory.api.ldap.model.message.Control	getRequestControl(String numericOid) Gets a request control if present for this request.
org.apache.directory.api.ldap.model.message.Control	getResponseControl(String numericOid) Gets a response control if present for this request.
int	getResponseControlCount() Checks the number of response controls have been generated for this operation.
org.apache.directory.api.ldap.model.message.Control[]	getResponseControls() Gets all the response controls producted during this operation.
CoreSession	getSession() Gets the session associated with this operation.
boolean	hasRequestControl(String numericOid) Checks to see if a request control is present on this request.
boolean	hasRequestControls() Checks if any request controls exists for this operation.
boolean	hasResponseControl(String numericOid) Checks to see if a response control is present on this operation.
boolean	hasResponseControls() Checks if any response controls have been generated for this operation.
void	ignoreReferral() Set the throwReferral flag to false
boolean	isReferralIgnored()
boolean	isReferralThrown()
org.apache.directory.api.ldap.model.entry.Entry	lookup(LookupOperationContext lookupContext)
LookupOperationContext	newLookupContext(org.apache.directory.api.ldap.model.name.Dn dn, String... attributes)
protected void	setAuthorizedPrincipal(LdapPrincipal authorizedPrincipal)
void	setCurrentInterceptor(int currentInterceptor) Sets the current interceptor number to a new value.
void	setDn(org.apache.directory.api.ldap.model.name.Dn dn) Set the context Dn
void	setEntry(org.apache.directory.api.ldap.model.entry.Entry entry) Sets the server entry associated with the target Dn of this OperationContext.
void	setInterceptors(List<String> interceptors) Sets the list of interceptors to go through for an operation
void	setOriginalEntry(org.apache.directory.api.ldap.model.entry.Entry originalEntry)
void	setRequestControls(Map<String,org.apache.directory.api.ldap.model.message.Control> requestControls)
void	setSession(CoreSession session)
void	throwReferral() Set the throwReferral flag to true

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_CONTROLS

protected static final org.apache.directory.api.ldap.model.message.Control[] EMPTY_CONTROLS

dn

protected org.apache.directory.api.ldap.model.name.Dn dn

The Dn associated with the context

entry

protected org.apache.directory.api.ldap.model.entry.Entry entry

The entry associated with the target entry of this OperationContext

originalEntry

protected org.apache.directory.api.ldap.model.entry.Entry originalEntry

The original Entry

requestControls

protected Map<String,org.apache.directory.api.ldap.model.message.Control> requestControls

The associated request's controls

responseControls

protected Map<String,org.apache.directory.api.ldap.model.message.Control> responseControls

The associated response's controls

byPassed

protected Collection<String> byPassed

the Interceptors bypassed by this operation

interceptors

protected List<String> interceptors

The interceptors to call for this operation

currentInterceptor

protected int currentInterceptor

The current interceptor position

authorizedPrincipal

protected LdapPrincipal authorizedPrincipal

session

protected CoreSession session

The core session

throwReferral

protected boolean throwReferral

A flag used to tell if we should consider referrals as standard entries

Constructor Detail

AbstractOperationContext

public AbstractOperationContext(CoreSession session)

Creates a new instance of AbstractOperationContext.

AbstractOperationContext

public AbstractOperationContext(CoreSession session,
                                org.apache.directory.api.ldap.model.name.Dn dn)

Creates a new instance of AbstractOperationContext.

Parameters:

dn - The associated Dn

Method Detail

getSession

public CoreSession getSession()

Gets the session associated with this operation.

Specified by:

getSession in interface OperationContext

Returns:

the session associated with this operation

setSession

public void setSession(CoreSession session)

setAuthorizedPrincipal

protected void setAuthorizedPrincipal(LdapPrincipal authorizedPrincipal)

getDn

public org.apache.directory.api.ldap.model.name.Dn getDn()

Specified by:

getDn in interface OperationContext

Returns:

The associated Dn

setDn

public void setDn(org.apache.directory.api.ldap.model.name.Dn dn)

Set the context Dn

Specified by:

setDn in interface OperationContext

Parameters:

dn - The Dn to set

addRequestControl

public void addRequestControl(org.apache.directory.api.ldap.model.message.Control requestControl)

Adds a request control to this operation.

Specified by:

addRequestControl in interface OperationContext

Parameters:

requestControl - the request control to add to this operation

getRequestControl

public org.apache.directory.api.ldap.model.message.Control getRequestControl(String numericOid)

Gets a request control if present for this request.

Specified by:

getRequestControl in interface OperationContext

Parameters:

numericOid - the numeric OID of the control also known as it's type OID

Returns:

the control if present

hasRequestControl

public boolean hasRequestControl(String numericOid)

Checks to see if a request control is present on this request.

Specified by:

hasRequestControl in interface OperationContext

Parameters:

numericOid - the numeric OID of the control also known as it's type OID

Returns:

true if the control is associated with this operation, false otherwise

hasRequestControls

public boolean hasRequestControls()

Checks if any request controls exists for this operation.

Specified by:

hasRequestControls in interface OperationContext

Returns:

true if any request controls exist, false otherwise

addResponseControl

public void addResponseControl(org.apache.directory.api.ldap.model.message.Control responseControl)

Adds a response control to this operation.

Specified by:

addResponseControl in interface OperationContext

Parameters:

responseControl - the response control to add to this operation

getResponseControl

public org.apache.directory.api.ldap.model.message.Control getResponseControl(String numericOid)

Gets a response control if present for this request.

Specified by:

getResponseControl in interface OperationContext

Parameters:

numericOid - the numeric OID of the control also known as it's type OID

Returns:

the control if present

hasResponseControl

public boolean hasResponseControl(String numericOid)

Checks to see if a response control is present on this operation.

Specified by:

hasResponseControl in interface OperationContext

Parameters:

numericOid - the numeric OID of the control also known as it's type OID

Returns:

true if the control is associated with this operation, false otherwise

getResponseControls

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

Gets all the response controls producted during this operation.

Specified by:

getResponseControls in interface OperationContext

Returns:

an array over all the response controls

hasResponseControls

public boolean hasResponseControls()

Checks if any response controls have been generated for this operation.

Specified by:

hasResponseControls in interface OperationContext

Returns:

true if any response controls have been generated, false otherwise

getResponseControlCount

public int getResponseControlCount()

Checks the number of response controls have been generated for this operation.

Specified by:

getResponseControlCount in interface OperationContext

Returns:

the number of response controls that have been generated

addRequestControls

public void addRequestControls(org.apache.directory.api.ldap.model.message.Control[] requestControls)

Adds many request controls to this operation.

Specified by:

addRequestControls in interface OperationContext

Parameters:

requestControls - the request controls to add to this operation

setRequestControls

public void setRequestControls(Map<String,org.apache.directory.api.ldap.model.message.Control> requestControls)

getName

public abstract String getName()

Specified by:

getName in interface OperationContext

Returns:

the operation name

getOriginalEntry

public org.apache.directory.api.ldap.model.entry.Entry getOriginalEntry()

Returns:

the originalEntry

setOriginalEntry

public void setOriginalEntry(org.apache.directory.api.ldap.model.entry.Entry originalEntry)

Parameters:

originalEntry - the originalEntry to set

setInterceptors

public final void setInterceptors(List<String> interceptors)

Sets the list of interceptors to go through for an operation

Specified by:

setInterceptors in interface OperationContext

Parameters:

interceptors - The list of interceptors

getNextInterceptor

public final String getNextInterceptor()

Gets the next interceptor in the list of interceptors. The position in the list will be incremented.

Specified by:

getNextInterceptor in interface OperationContext

Returns:

The next interceptor from the list of interceptors

getCurrentInterceptor

public int getCurrentInterceptor()

Specified by:

getCurrentInterceptor in interface OperationContext

Returns:

The number of the current interceptor in the list

setCurrentInterceptor

public void setCurrentInterceptor(int currentInterceptor)

Sets the current interceptor number to a new value.

Specified by:

setCurrentInterceptor in interface OperationContext

Parameters:

currentInterceptor - The new current interceptor value

delete

public void delete(org.apache.directory.api.ldap.model.name.Dn dn)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Process the delete for inner operations. This is only valid for SubschemaSubentry operations, and will most certainly be removed later.

Specified by:

delete in interface OperationContext

Throws:

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

lookup

public org.apache.directory.api.ldap.model.entry.Entry lookup(LookupOperationContext lookupContext)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

lookup in interface OperationContext

Throws:

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

newLookupContext

public LookupOperationContext newLookupContext(org.apache.directory.api.ldap.model.name.Dn dn,
                                               String... attributes)

Specified by:

newLookupContext in interface OperationContext

getEffectivePrincipal

public LdapPrincipal getEffectivePrincipal()

Gets the effective principal for this operation which may not be the same as the authenticated principal when the session for this context has an explicit authorization id, or this operation was applied with the proxy authorization control.

Specified by:

getEffectivePrincipal in interface OperationContext

Returns:

the effective principal for this operation

See Also:

CoreSession.getAuthenticatedPrincipal(), CoreSession.getEffectivePrincipal()

setEntry

public void setEntry(org.apache.directory.api.ldap.model.entry.Entry entry)

Description copied from interface: OperationContext

Sets the server entry associated with the target Dn of this OperationContext.

Specified by:

setEntry in interface OperationContext

Parameters:

entry - the entry to set

getEntry

public org.apache.directory.api.ldap.model.entry.Entry getEntry()

Description copied from interface: OperationContext

Gets the server entry associated with the target Dn of this OperationContext. The entry associated with the Dn may be altered during the course of processing an LDAP operation through the InterceptorChain. This place holder is put here to prevent the need for repetitive lookups of the target entry. Furthermore the returned entry may be altered by any Interceptor in the chain and this is why a ClonedServerEntry is returned instead of a Entry. A ClonedServerEntry has an immutable reference to the original state of the target entry. The original state can be accessed via a call to ClonedServerEntry#getOriginalEntry(). The return value may be null in which case any lookup performed to access it may set it to prevent the need for subsequent lookups. Also note that during the course of handling some operations such as those that rename, move or rename and move the entry, may alter the Dn of this entry. Interceptor implementors should not presume the Dn or the values contained in this entry are currently what is present in the DIT. The original entry contained in the ClonedServerEntry shoudl be used as the definitive source of information about the state of the entry in the DIT before returning from the Partition subsystem.

Specified by:

getEntry in interface OperationContext

Returns:

the entry

throwReferral

public void throwReferral()

Set the throwReferral flag to true

Specified by:

throwReferral in interface OperationContext

isReferralThrown

public boolean isReferralThrown()

Specified by:

isReferralThrown in interface OperationContext

Returns:

true if the referrals are thrown

ignoreReferral

public void ignoreReferral()

Set the throwReferral flag to false

Specified by:

ignoreReferral in interface OperationContext

isReferralIgnored

public boolean isReferralIgnored()

Specified by:

isReferralIgnored in interface OperationContext

Returns:

true if the referrals are ignored