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

Class CompareOperationContext

java.lang.Object

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

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

All Implemented Interfaces:

OperationContext

public class CompareOperationContext
extends AbstractOperationContext

A Compare context used for Interceptors. It contains all the informations needed for the compare operation, and used by all the interceptors

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.schema.AttributeType	attributeType The associated AttributeType
private java.lang.String	oid The entry OID
private org.apache.directory.api.ldap.model.entry.Value<?>	value The value to be compared

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
CompareOperationContext(CoreSession session) Creates a new instance of CompareOperationContext.
CompareOperationContext(CoreSession session, org.apache.directory.api.ldap.model.message.CompareRequest compareRequest)
CompareOperationContext(CoreSession session, org.apache.directory.api.ldap.model.name.Dn dn) Creates a new instance of CompareOperationContext.
CompareOperationContext(CoreSession session, org.apache.directory.api.ldap.model.name.Dn dn, java.lang.String oid) Creates a new instance of LookupOperationContext.
CompareOperationContext(CoreSession session, org.apache.directory.api.ldap.model.name.Dn dn, java.lang.String oid, org.apache.directory.api.ldap.model.entry.Value<?> value) Creates a new instance of LookupOperationContext.
CompareOperationContext(CoreSession session, java.lang.String oid) Creates a new instance of LookupOperationContext.

Method Summary

Modifier and Type	Method and Description
org.apache.directory.api.ldap.model.schema.AttributeType	getAttributeType()
java.lang.String	getName()
java.lang.String	getOid()
org.apache.directory.api.ldap.model.entry.Value<?>	getValue()
void	setAttributeType(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Set the AttributeType associated with the OID
void	setOid(java.lang.String oid) Set the compared OID
void	setValue(org.apache.directory.api.ldap.model.entry.Value<?> value) Set the value to compare
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, 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

Field Detail

oid

private java.lang.String oid

The entry OID

attributeType

private org.apache.directory.api.ldap.model.schema.AttributeType attributeType

The associated AttributeType

value

private org.apache.directory.api.ldap.model.entry.Value<?> value

The value to be compared

Constructor Detail

CompareOperationContext

public CompareOperationContext(CoreSession session)

Creates a new instance of CompareOperationContext.

CompareOperationContext

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

Creates a new instance of CompareOperationContext.

CompareOperationContext

public CompareOperationContext(CoreSession session,
                               java.lang.String oid)

Creates a new instance of LookupOperationContext.

CompareOperationContext

public CompareOperationContext(CoreSession session,
                               org.apache.directory.api.ldap.model.name.Dn dn,
                               java.lang.String oid)

Creates a new instance of LookupOperationContext.

CompareOperationContext

public CompareOperationContext(CoreSession session,
                               org.apache.directory.api.ldap.model.name.Dn dn,
                               java.lang.String oid,
                               org.apache.directory.api.ldap.model.entry.Value<?> value)

Creates a new instance of LookupOperationContext.

CompareOperationContext

public CompareOperationContext(CoreSession session,
                               org.apache.directory.api.ldap.model.message.CompareRequest compareRequest)

Method Detail

getOid

public java.lang.String getOid()

Returns:

The compared OID

setOid

public void setOid(java.lang.String oid)

Set the compared OID

Parameters:

oid - The compared OID

getValue

public org.apache.directory.api.ldap.model.entry.Value<?> getValue()

Returns:

The value to compare

setValue

public void setValue(org.apache.directory.api.ldap.model.entry.Value<?> value)

Set the value to compare

Parameters:

value - The value to compare

getAttributeType

public org.apache.directory.api.ldap.model.schema.AttributeType getAttributeType()

Returns:

The AttributeType for the compared value

setAttributeType

public void setAttributeType(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)

Set the AttributeType associated with the OID

Parameters:

attributeType - The AttributeType

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()