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

Class FilteringOperationContext

java.lang.Object

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

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

All Implemented Interfaces:

OperationContext

Direct Known Subclasses:

LookupOperationContext, SearchOperationContext

public abstract class FilteringOperationContext
extends AbstractOperationContext

A context used to store the filter used to manage the Attributes the user ha srequested. It's used by the Lookup, List and Search operations

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allOperationalAttributes A flag set to true if the user has requested all the operational attributes ( "+" )
private boolean	allUserAttributes A flag set to true if the user has requested all the user attributes ( "*" )
protected static org.slf4j.Logger	LOG The LoggerFactory used by this Interceptor
private boolean	noAttributes A flag set to true if the user has requested no attribute to be returned (1.1)
protected java.util.Set<org.apache.directory.api.ldap.model.schema.AttributeTypeOptions>	returningAttributes A set containing the returning attributeTypesOptions
protected java.lang.String[]	returningAttributesString The set of attributes to return as String
protected boolean	typesOnly A flag to tell if only the attribute names to be returned.

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

Method Summary

Modifier and Type	Method and Description
private java.util.Set<org.apache.directory.api.ldap.model.schema.AttributeTypeOptions>	collectAttributeTypes(java.lang.String... attributesIds)
boolean	contains(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Tells if an attribute is present in the list of attribute to return
boolean	contains(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, java.lang.String attribute) Tells if an attribute is present in the list of attribute to return
java.util.Set<org.apache.directory.api.ldap.model.schema.AttributeTypeOptions>	getReturningAttributes() Add an attribute ID to the current list, creating the list if necessary
java.lang.String[]	getReturningAttributesString()
boolean	isAllOperationalAttributes()
boolean	isAllUserAttributes()
boolean	isNoAttributes()
boolean	isTypesOnly()
void	setAllOperationalAttributes(boolean allOperationalAttribute)
void	setAllUserAttributes(boolean allUserAttributes)
void	setNoAttributes(boolean noAttributes)
void	setReturningAttributes(java.lang.String... attributeIds)
void	setTypesOnly(boolean typesOnly)
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, 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, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

The LoggerFactory used by this Interceptor

returningAttributes

protected java.util.Set<org.apache.directory.api.ldap.model.schema.AttributeTypeOptions> returningAttributes

A set containing the returning attributeTypesOptions

returningAttributesString

protected java.lang.String[] returningAttributesString

The set of attributes to return as String

allOperationalAttributes

private boolean allOperationalAttributes

A flag set to true if the user has requested all the operational attributes ( "+" )

allUserAttributes

private boolean allUserAttributes

A flag set to true if the user has requested all the user attributes ( "*" )

noAttributes

private boolean noAttributes

A flag set to true if the user has requested no attribute to be returned (1.1)

typesOnly

protected boolean typesOnly

A flag to tell if only the attribute names to be returned.

Constructor Detail

FilteringOperationContext

public FilteringOperationContext(CoreSession session)

Creates a new instance of LookupOperationContext.

FilteringOperationContext

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

Creates a new instance of LookupOperationContext.

FilteringOperationContext

public FilteringOperationContext(CoreSession session,
                                 java.lang.String... returningAttributes)

Creates a new instance of LookupOperationContext.

FilteringOperationContext

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

Creates a new instance of LookupOperationContext.

Method Detail

getReturningAttributes

public java.util.Set<org.apache.directory.api.ldap.model.schema.AttributeTypeOptions> getReturningAttributes()

Add an attribute ID to the current list, creating the list if necessary

Parameters:

attrId - the Id to add public void addAttrsId( String attrId ) { if ( noAttributes == null ) { if ( attrId.equals( SchemaConstants.NO_ATTRIBUTE ) ) { noAttributes = true; if ( attrsId != null ) { attrsId.clear(); } return; } if ( attrId.equals( SchemaConstants.ALL_USER_ATTRIBUTES ) ) { allUserAttributes = true; return; } if ( attrId.equals( SchemaConstants.ALL_OPERATIONAL_ATTRIBUTES ) ) { allOperationalAttributes = true; return; } if ( attrsId == null ) { attrsId = new ArrayList(); } attrsId.add( attrId ); } } /**

Returns:

the returningAttributes as a Set of AttributeTypeOptions

getReturningAttributesString

public java.lang.String[] getReturningAttributesString()

Returns:

the returning Attributes, as a array of Strings

contains

public boolean contains(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                        java.lang.String attribute)

Tells if an attribute is present in the list of attribute to return

Parameters:

attribute - The attribute we are looking for

Returns:

true if the attribute is present

contains

public boolean contains(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                        org.apache.directory.api.ldap.model.schema.AttributeType attributeType)

Tells if an attribute is present in the list of attribute to return

Parameters:

attributeType - The attributeType we are looking for

Returns:

true if the attribute is present

setReturningAttributes

public void setReturningAttributes(java.lang.String... attributeIds)

collectAttributeTypes

private java.util.Set<org.apache.directory.api.ldap.model.schema.AttributeTypeOptions> collectAttributeTypes(java.lang.String... attributesIds)

setAllOperationalAttributes

public void setAllOperationalAttributes(boolean allOperationalAttribute)

Parameters:

allOperationalAttributes - the allOperationalAttributes to set

isAllUserAttributes

public boolean isAllUserAttributes()

Returns:

The flag telling if the "*" attribute has been used

setAllUserAttributes

public void setAllUserAttributes(boolean allUserAttributes)

Parameters:

allUserAttributes - the allUserAttributes to set

isAllOperationalAttributes

public boolean isAllOperationalAttributes()

Returns:

The flag telling if the "+" attribute has been used

isNoAttributes

public boolean isNoAttributes()

Returns:

The flag telling if the "1.1" attribute has been used

setNoAttributes

public void setNoAttributes(boolean noAttributes)

Parameters:

noAttributes - the noAttributes to set

isTypesOnly

public boolean isTypesOnly()

Returns:

true, if attribute descriptions alone need to be returned

setTypesOnly

public void setTypesOnly(boolean typesOnly)

Parameters:

typesOnly - true If we want to get back the attributeType only

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()