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

Class AbstractChangeOperationContext

java.lang.Object

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

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

All Implemented Interfaces:

ChangeOperationContext, OperationContext

Direct Known Subclasses:

AddOperationContext, DeleteOperationContext, ModifyOperationContext, MoveOperationContext, RenameOperationContext

public abstract class AbstractChangeOperationContext
extends AbstractOperationContext
implements ChangeOperationContext

An abstract base class used by all change inducing operations.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected LogChange	logChange The flag used to tell the server to store the changes into the changeLog
protected org.apache.directory.api.ldap.model.entry.Entry	modifiedEntry The modified Entry as it will be stored into the backend

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
AbstractChangeOperationContext(CoreSession session) Creates a new instance of AbstractChangeOperationContext.
AbstractChangeOperationContext(CoreSession session, org.apache.directory.api.ldap.model.name.Dn dn) Creates a new instance of AbstractChangeOperationContext.

Method Summary

Modifier and Type	Method and Description
ChangeLogEvent	getChangeLogEvent() Gets the ChangeLogEvent associated with this operation after the operation has been executed.
org.apache.directory.api.ldap.model.entry.Entry	getModifiedEntry()
int	getRid()
boolean	isGenerateNoReplEvt()
boolean	isLogChange()
boolean	isPushToEvtInterceptor()
boolean	isReplEvent()
void	setChangeLogEvent(ChangeLogEvent changeLogEvent)
void	setGenerateNoReplEvt(boolean generateNoReplEvt) sets whether or not to generate replication event messages by after an operation using this operation context completes
void	setLogChange(LogChange logChange) Set the flag which tells the server to log the changes into the changeLog file
void	setModifiedEntry(org.apache.directory.api.ldap.model.entry.Entry modifiedEntry)
void	setPushToEvtInterceptor(boolean pushToEvtIntrcptor) sets if this context needs to be pushed to the event interceptor from nexus
void	setReplEvent(boolean replEvent)
void	setRid(int rid) sets the replica ID received from a consumer

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.server.core.api.interceptor.context.OperationContext

addRequestControl, addRequestControls, addResponseControl, delete, getCurrentInterceptor, getDn, getEffectivePrincipal, getEntry, getName, getNextInterceptor, getRequestControl, getResponseControl, getResponseControlCount, getResponseControls, getSession, hasRequestControl, hasRequestControls, hasResponseControl, hasResponseControls, ignoreReferral, isReferralIgnored, isReferralThrown, lookup, newLookupContext, setCurrentInterceptor, setDn, setEntry, setInterceptors, throwReferral

Field Detail

logChange

protected LogChange logChange

The flag used to tell the server to store the changes into the changeLog

modifiedEntry

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

The modified Entry as it will be stored into the backend

Constructor Detail

AbstractChangeOperationContext

public AbstractChangeOperationContext(CoreSession session)

Creates a new instance of AbstractChangeOperationContext.

Parameters:

session -

AbstractChangeOperationContext

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

Creates a new instance of AbstractChangeOperationContext.

Parameters:

session -

Method Detail

getModifiedEntry

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

Returns:

the modifiedEntry

setModifiedEntry

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

Parameters:

modifiedEntry - the modifiedEntry to set

getChangeLogEvent

public ChangeLogEvent getChangeLogEvent()

Description copied from interface: ChangeOperationContext

Gets the ChangeLogEvent associated with this operation after the operation has been executed. Returns null if the ChangeLogService has not been enabled.

Specified by:

getChangeLogEvent in interface ChangeOperationContext

Returns:

the ChangeLogEvent associated with this operation, or null

See Also:

ChangeOperationContext.getChangeLogEvent()

setChangeLogEvent

public void setChangeLogEvent(ChangeLogEvent changeLogEvent)

setLogChange

public void setLogChange(LogChange logChange)

Set the flag which tells the server to log the changes into the changeLog file

Specified by:

setLogChange in interface ChangeOperationContext

Parameters:

logChange - The flag

isLogChange

public boolean isLogChange()

Specified by:

isLogChange in interface ChangeOperationContext

Returns:

True if the changes are logged into the changeLog

isReplEvent

public boolean isReplEvent()

Returns:

true if this context is containing a replication event

setReplEvent

public void setReplEvent(boolean replEvent)

Parameters:

replEvent - mark the context as containing a replication event

getRid

public int getRid()

Returns:

the replica ID received from a consumer

setRid

public void setRid(int rid)

sets the replica ID received from a consumer

Parameters:

rid -

isGenerateNoReplEvt

public boolean isGenerateNoReplEvt()

Returns:

true if a replication event shouldn't be generated for the changes done using this operation context, false otherwise

setGenerateNoReplEvt

public void setGenerateNoReplEvt(boolean generateNoReplEvt)

sets whether or not to generate replication event messages by after an operation using this operation context completes

Parameters:

generateNoReplEvt -

isPushToEvtInterceptor

public boolean isPushToEvtInterceptor()

Returns:

true if this context needs to be pushed to the event interceptor from nexus

setPushToEvtInterceptor

public void setPushToEvtInterceptor(boolean pushToEvtIntrcptor)

sets if this context needs to be pushed to the event interceptor from nexus

Parameters:

pushToEvtInterceptor -