org.apache.directory.server.core.interceptor.context
Class ListOperationContext

java.lang.Object
  extended by org.apache.directory.server.core.interceptor.context.AbstractOperationContext
      extended by org.apache.directory.server.core.interceptor.context.SearchingOperationContext
          extended by org.apache.directory.server.core.interceptor.context.ListOperationContext
All Implemented Interfaces:
OperationContext

public class ListOperationContext
extends SearchingOperationContext

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

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.server.core.interceptor.context.SearchingOperationContext
abandoned, aliasDerefMode, allOperationalAttributes, allUserAttributes, noAttributes, returningAttributes, scope, sizeLimit, timeLimit, typesOnly
 
Fields inherited from class org.apache.directory.server.core.interceptor.context.AbstractOperationContext
authorizedPrincipal, byPassed, dn, EMPTY_CONTROLS, entry, next, previous, requestControls, responseControls, session, throwReferral
 
Constructor Summary
ListOperationContext(CoreSession session)
          Creates a new instance of ListOperationContext.
ListOperationContext(CoreSession session, org.apache.directory.shared.ldap.name.DN dn)
          Creates a new instance of ListOperationContext.
ListOperationContext(CoreSession session, org.apache.directory.shared.ldap.name.DN dn, java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes)
          Creates a new instance of ListOperationContext with attributes to return.
 
Method Summary
 java.lang.String getName()
           
 java.lang.String toString()
           
 
Methods inherited from class org.apache.directory.server.core.interceptor.context.SearchingOperationContext
getAliasDerefMode, getReturningAttributes, getScope, getSearchControls, getSearchControls, getSizeLimit, getTimeLimit, isAbandoned, isAllOperationalAttributes, isAllUserAttributes, isNoAttributes, isTypesOnly, setAbandoned, setAliasDerefMode, setAllOperationalAttributes, setAllUserAttributes, setNoAttributes, setReturningAttributes, setReturningAttributes, setReturningAttributes, setScope, setSizeLimit, setTimeLimit, setTypesOnly
 
Methods inherited from class org.apache.directory.server.core.interceptor.context.AbstractOperationContext
add, addRequestControl, addRequestControls, addResponseControl, delete, getByPassed, getDn, getEffectivePrincipal, getEntry, getFirstOperation, getLastOperation, getNextOperation, getPreviousOperation, getRequestControl, getResponseControl, getResponseControlCount, getResponseControls, getSession, hasBypass, hasEntry, hasRequestControl, hasRequestControls, hasResponseControl, hasResponseControls, ignoreReferral, isBypassed, isFirstOperation, isReferralIgnored, isReferralThrown, lookup, lookup, modify, newLookupContext, setAuthorizedPrincipal, setByPassed, setDn, setEntry, setNextOperation, setPreviousOperation, setRequestControls, setSession, throwReferral
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ListOperationContext

public ListOperationContext(CoreSession session)
Creates a new instance of ListOperationContext.


ListOperationContext

public ListOperationContext(CoreSession session,
                            org.apache.directory.shared.ldap.name.DN dn)
Creates a new instance of ListOperationContext.

Parameters:
dn - The DN to get the suffix from

ListOperationContext

public ListOperationContext(CoreSession session,
                            org.apache.directory.shared.ldap.name.DN dn,
                            java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes)
Creates a new instance of ListOperationContext with attributes to return.

Parameters:
session - the session associated with this OperationContext
dn - the base DN
aliasDerefMode - the alias dereferencing mode to use
returningAttributes - the attributes to return
Method Detail

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 SearchingOperationContext
See Also:
Object.toString()


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.