|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.server.core.interceptor.context.AbstractOperationContext
org.apache.directory.server.core.interceptor.context.SearchingOperationContext
public abstract class SearchingOperationContext
A context used for search related operations and used by all the Interceptors.
Field Summary | |
---|---|
protected boolean |
abandoned
A flag if the search operation is abandoned |
protected org.apache.directory.shared.ldap.message.AliasDerefMode |
aliasDerefMode
A flag describing the way alias should be handled |
protected boolean |
allOperationalAttributes
A flag set if the returned attributes set contains '+' |
protected boolean |
allUserAttributes
A flag set if the returned attributes set contains '*' |
protected boolean |
noAttributes
A flag set if the returned attributes set contains '1.1' |
protected java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> |
returningAttributes
A set containing the returning attributeTypesOptions |
protected org.apache.directory.shared.ldap.filter.SearchScope |
scope
The scope for this search : default to One Level |
protected long |
sizeLimit
The sizeLimit for this search operation |
protected int |
timeLimit
The timeLimit for this search operation |
Fields inherited from class org.apache.directory.server.core.interceptor.context.AbstractOperationContext |
---|
authorizedPrincipal, byPassed, dn, EMPTY_CONTROLS, entry, next, previous, requestControls, responseControls, session |
Constructor Summary | |
---|---|
SearchingOperationContext(CoreSession session)
Creates a new instance of ListOperationContext. |
|
SearchingOperationContext(CoreSession session,
org.apache.directory.shared.ldap.name.LdapDN dn)
Creates a new instance of ListOperationContext. |
|
SearchingOperationContext(CoreSession session,
org.apache.directory.shared.ldap.name.LdapDN dn,
org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefMode)
Creates a new instance of ListOperationContext. |
|
SearchingOperationContext(CoreSession session,
org.apache.directory.shared.ldap.name.LdapDN dn,
org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefMode,
javax.naming.directory.SearchControls searchControls)
Creates a new instance of ListOperationContext. |
|
SearchingOperationContext(CoreSession session,
org.apache.directory.shared.ldap.name.LdapDN dn,
org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefMode,
java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes)
Creates a new instance of a SearchingOperationContext using one level scope, with attributes to return. |
Method Summary | |
---|---|
org.apache.directory.shared.ldap.message.AliasDerefMode |
getAliasDerefMode()
|
java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> |
getReturningAttributes()
|
org.apache.directory.shared.ldap.filter.SearchScope |
getScope()
|
javax.naming.directory.SearchControls |
getSearchControls()
Creates a new SearchControls object populated with the parameters contained in this SearchOperationContext in normalized form. |
javax.naming.directory.SearchControls |
getSearchControls(boolean denormalized)
Creates a new SearchControls object populated with the parameters contained in this SearchOperationContext. |
long |
getSizeLimit()
|
int |
getTimeLimit()
|
boolean |
isAbandoned()
|
boolean |
isAllOperationalAttributes()
|
boolean |
isAllUserAttributes()
|
boolean |
isNoAttributes()
|
void |
setAbandoned(boolean abandoned)
|
void |
setAllOperationalAttributes(boolean allOperationalAttribute)
|
void |
setAllUserAttributes(boolean allUserAttributes)
|
void |
setNoAttributes(boolean noAttributes)
|
protected void |
setReturningAttributes(java.util.Collection<java.lang.String> attributesIds)
|
void |
setReturningAttributes(java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes)
|
protected void |
setReturningAttributes(java.lang.String[] attributesIds)
|
void |
setScope(org.apache.directory.shared.ldap.filter.SearchScope scope)
|
void |
setSizeLimit(long sizeLimit)
|
void |
setTimeLimit(int timeLimit)
|
java.lang.String |
toString()
|
Methods inherited from class org.apache.directory.server.core.interceptor.context.AbstractOperationContext |
---|
add, addRequestControl, addRequestControls, addResponseControl, delete, getByPassed, getDn, getEffectivePrincipal, getEntry, getFirstOperation, getLastOperation, getName, getNextOperation, getPreviousOperation, getRequestControl, getResponseControl, getResponseControlCount, getResponseControls, getSession, hasBypass, hasEntry, hasRequestControl, hasRequestControls, hasResponseControl, hasResponseControls, isBypassed, isFirstOperation, lookup, lookup, modify, newLookupContext, setAuthorizedPrincipal, setByPassed, setDn, setEntry, setNextOperation, setPreviousOperation, setRequestControls, setSession |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefMode
protected long sizeLimit
protected int timeLimit
protected org.apache.directory.shared.ldap.filter.SearchScope scope
protected boolean allOperationalAttributes
protected boolean allUserAttributes
protected boolean noAttributes
protected java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes
protected boolean abandoned
Constructor Detail |
---|
public SearchingOperationContext(CoreSession session)
public SearchingOperationContext(CoreSession session, org.apache.directory.shared.ldap.name.LdapDN dn)
dn
- The DN to get the suffix frompublic SearchingOperationContext(CoreSession session, org.apache.directory.shared.ldap.name.LdapDN dn, org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefMode)
dn
- The DN to get the suffix fromaliasDerefMode
- the alias dereferencing mode to usepublic SearchingOperationContext(CoreSession session, org.apache.directory.shared.ldap.name.LdapDN dn, org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefMode, javax.naming.directory.SearchControls searchControls) throws java.lang.Exception
dn
- The DN to get the suffix fromaliasDerefMode
- the alias dereferencing mode to use
javax.naming.NamingException
java.lang.Exception
public SearchingOperationContext(CoreSession session, org.apache.directory.shared.ldap.name.LdapDN dn, org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefMode, java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes)
dn
- The DN to get the suffix fromaliasDerefMode
- the alias dereferencing mode to use
javax.naming.NamingException
Method Detail |
---|
protected void setReturningAttributes(java.util.Collection<java.lang.String> attributesIds) throws java.lang.Exception
java.lang.Exception
protected void setReturningAttributes(java.lang.String[] attributesIds) throws java.lang.Exception
java.lang.Exception
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public org.apache.directory.shared.ldap.message.AliasDerefMode getAliasDerefMode()
public void setSizeLimit(long sizeLimit)
sizeLimit
- the sizeLimit to setpublic long getSizeLimit()
public void setTimeLimit(int timeLimit)
timeLimit
- the timeLimit to setpublic int getTimeLimit()
public void setScope(org.apache.directory.shared.ldap.filter.SearchScope scope)
scope
- the scope to setpublic org.apache.directory.shared.ldap.filter.SearchScope getScope()
public void setAllOperationalAttributes(boolean allOperationalAttribute)
allOperationalAttributes
- the allOperationalAttributes to setpublic boolean isAllOperationalAttributes()
public void setAllUserAttributes(boolean allUserAttributes)
allUserAttributes
- the allUserAttributes to setpublic boolean isAllUserAttributes()
public void setNoAttributes(boolean noAttributes)
noAttributes
- the noAttributes to setpublic boolean isNoAttributes()
public void setReturningAttributes(java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes)
returningAttributes
- the returningAttributes to setpublic java.util.Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> getReturningAttributes()
public javax.naming.directory.SearchControls getSearchControls()
public javax.naming.directory.SearchControls getSearchControls(boolean denormalized)
denormalized
- true if attribute values are not normalized
public void setAbandoned(boolean abandoned)
abandoned
- the abandoned to setpublic boolean isAbandoned()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |