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

Interface OperationContext

All Known Subinterfaces:

ChangeOperationContext

All Known Implementing Classes:

AbstractChangeOperationContext, AbstractOperationContext, AddOperationContext, BindOperationContext, CompareOperationContext, DeleteOperationContext, EmptyOperationContext, FilteringOperationContext, GetRootDseOperationContext, HasEntryOperationContext, LookupOperationContext, ModifyOperationContext, MoveAndRenameOperationContext, MoveOperationContext, RenameOperationContext, SearchOperationContext, UnbindOperationContext

public interface OperationContext

This interface represent the context passed as an argument to each interceptor. It will contain data used by all the operations.

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.
java.lang.String	getName()
java.lang.String	getNextInterceptor() Gets the next interceptor in the list of interceptors.
org.apache.directory.api.ldap.model.message.Control	getRequestControl(java.lang.String numericOid) Gets a request control if present for this request.
org.apache.directory.api.ldap.model.message.Control	getResponseControl(java.lang.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(java.lang.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(java.lang.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, java.lang.String... attributes)
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(java.util.List<java.lang.String> interceptors) Sets the list of interceptors to go through for an operation
void	throwReferral() Set the throwReferral flag to true

Method Detail

getCurrentInterceptor

int getCurrentInterceptor()

Returns:

The number of the current interceptor in the list

setCurrentInterceptor

void setCurrentInterceptor(int currentInterceptor)

Sets the current interceptor number to a new value.

Parameters:

currentInterceptor - The new current interceptor value

getEffectivePrincipal

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.

Returns:

the effective principal for this operation

See Also:

CoreSession.getAuthenticatedPrincipal(), CoreSession.getEffectivePrincipal()

getDn

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

Returns:

The associated Dn

setDn

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

Set the context Dn

Parameters:

dn - The Dn to set

getEntry

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

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.

Returns:

target entry associated with the Dn of this OperationContext

setEntry

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

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

Parameters:

entry - the entry whose Dn is associated with this OperationContext.

addResponseControl

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

Adds a response control to this operation.

Parameters:

responseControl - the response control to add to this operation

hasResponseControl

boolean hasResponseControl(java.lang.String numericOid)

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

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

getResponseControl

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

Gets a response control if present for this request.

Parameters:

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

Returns:

the control if present

getResponseControls

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

Gets all the response controls producted during this operation.

Returns:

an array over all the response controls

hasResponseControls

boolean hasResponseControls()

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

Returns:

true if any response controls have been generated, false otherwise

getResponseControlCount

int getResponseControlCount()

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

Returns:

the number of response controls that have been generated

addRequestControl

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

Adds a request control to this operation.

Parameters:

requestControl - the request control to add to this operation

hasRequestControl

boolean hasRequestControl(java.lang.String numericOid)

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

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

boolean hasRequestControls()

Checks if any request controls exists for this operation.

Returns:

true if any request controls exist, false otherwise

getRequestControl

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

Gets a request control if present for this request.

Parameters:

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

Returns:

the control if present

addRequestControls

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

Adds many request controls to this operation.

Parameters:

requestControls - the request controls to add to this operation

getName

java.lang.String getName()

Returns:

the operation's name

getNextInterceptor

java.lang.String getNextInterceptor()

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

Returns:

The next interceptor from the list of interceptors

setInterceptors

void setInterceptors(java.util.List<java.lang.String> interceptors)

Sets the list of interceptors to go through for an operation

Parameters:

interceptors - The list of interceptors

getSession

CoreSession getSession()

Gets the session associated with this operation.

Returns:

the session associated with this operation

newLookupContext

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

lookup

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

Throws:

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

delete

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.

Parameters:

dn -

Throws:

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

throwReferral

void throwReferral()

Set the throwReferral flag to true

isReferralThrown

boolean isReferralThrown()

Returns:

true if the referrals are thrown

ignoreReferral

void ignoreReferral()

Set the throwReferral flag to false

isReferralIgnored

boolean isReferralIgnored()

Returns:

true if the referrals are ignored