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

Class ModifyOperationContext

java.lang.Object

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

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

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

All Implemented Interfaces:

ChangeOperationContext, OperationContext

public class ModifyOperationContext
extends AbstractChangeOperationContext

A Modify context used for Interceptors. It contains all the informations needed for the modify operation, and used by all the interceptors This context can use either Attributes or ModificationItem, but not both.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.entry.Entry	alteredEntry The entry after being renamed and altered for rdn attributes
private java.util.List<org.apache.directory.api.ldap.model.entry.Modification>	modItems The modification items

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

logChange, modifiedEntry

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
ModifyOperationContext(CoreSession session) Creates a new instance of ModifyOperationContext.
ModifyOperationContext(CoreSession session, org.apache.directory.api.ldap.model.name.Dn dn, java.util.List<org.apache.directory.api.ldap.model.entry.Modification> modItems) Creates a new instance of ModifyOperationContext.
ModifyOperationContext(CoreSession session, org.apache.directory.api.ldap.model.message.ModifyRequest modifyRequest)

Method Summary

Modifier and Type	Method and Description
static java.util.List<org.apache.directory.api.ldap.model.entry.Modification>	createModItems(org.apache.directory.api.ldap.model.entry.Entry serverEntry, org.apache.directory.api.ldap.model.entry.ModificationOperation modOp)
org.apache.directory.api.ldap.model.entry.Entry	getAlteredEntry() Returns the entry after it has been renamed and potentially changed for Rdn alterations.
java.util.List<org.apache.directory.api.ldap.model.entry.Modification>	getModItems()
java.lang.String	getName()
void	setAlteredEntry(org.apache.directory.api.ldap.model.entry.Entry alteredEntry) Set the modified entry once the operation has been proceced on the backend.
void	setModItems(java.util.List<org.apache.directory.api.ldap.model.entry.Modification> modItems) Set the modified attributes
java.lang.String	toString()

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

getChangeLogEvent, getModifiedEntry, getRid, isGenerateNoReplEvt, isLogChange, isPushToEvtInterceptor, isReplEvent, setChangeLogEvent, setGenerateNoReplEvt, setLogChange, setModifiedEntry, setPushToEvtInterceptor, setReplEvent, setRid

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, 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, wait, wait, wait

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

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

Field Detail

modItems

private java.util.List<org.apache.directory.api.ldap.model.entry.Modification> modItems

The modification items

alteredEntry

private org.apache.directory.api.ldap.model.entry.Entry alteredEntry

The entry after being renamed and altered for rdn attributes

Constructor Detail

ModifyOperationContext

public ModifyOperationContext(CoreSession session)

Creates a new instance of ModifyOperationContext.

ModifyOperationContext

public ModifyOperationContext(CoreSession session,
                              org.apache.directory.api.ldap.model.name.Dn dn,
                              java.util.List<org.apache.directory.api.ldap.model.entry.Modification> modItems)

Creates a new instance of ModifyOperationContext.

Parameters:

dn - the dn of the entry to be modified

modItems - the modifications to be performed on the entry

ModifyOperationContext

public ModifyOperationContext(CoreSession session,
                              org.apache.directory.api.ldap.model.message.ModifyRequest modifyRequest)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

Method Detail

setModItems

public void setModItems(java.util.List<org.apache.directory.api.ldap.model.entry.Modification> modItems)

Set the modified attributes

Parameters:

modItems - The modified attributes

getModItems

public java.util.List<org.apache.directory.api.ldap.model.entry.Modification> getModItems()

Returns:

The modifications

createModItems

public static java.util.List<org.apache.directory.api.ldap.model.entry.Modification> createModItems(org.apache.directory.api.ldap.model.entry.Entry serverEntry,
                                                                                                    org.apache.directory.api.ldap.model.entry.ModificationOperation modOp)
                                                                                             throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

getName

public java.lang.String getName()

Specified by:

getName in interface OperationContext

Specified by:

getName in class AbstractOperationContext

Returns:

the operation name

getAlteredEntry

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

Returns the entry after it has been renamed and potentially changed for Rdn alterations.

Returns:

the new renamed entry

setAlteredEntry

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

Set the modified entry once the operation has been proceced on the backend.

Parameters:

alteredEntry - The modified entry

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()