public abstract class SearchingOperationContext extends AbstractOperationContext
Modifier and Type | Field and Description |
---|---|
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 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
|
protected boolean |
typesOnly
A flag to tell if only the attribute names to be returned
|
authorizedPrincipal, byPassed, dn, EMPTY_CONTROLS, entry, next, previous, requestControls, responseControls, session, throwReferral
Constructor and Description |
---|
SearchingOperationContext(CoreSession session)
Creates a new instance of SearchingOperationContext.
|
SearchingOperationContext(CoreSession session,
org.apache.directory.shared.ldap.name.DN dn)
Creates a new instance of SearchingOperationContext.
|
SearchingOperationContext(CoreSession session,
org.apache.directory.shared.ldap.name.DN dn,
Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes)
Creates a new instance of a SearchingOperationContext using one level
scope, with attributes to return.
|
Modifier and Type | Method and Description |
---|---|
org.apache.directory.shared.ldap.message.AliasDerefMode |
getAliasDerefMode() |
Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> |
getReturningAttributes() |
org.apache.directory.shared.ldap.filter.SearchScope |
getScope() |
SearchControls |
getSearchControls()
Creates a new SearchControls object populated with the parameters
contained in this SearchOperationContext in normalized form.
|
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() |
boolean |
isTypesOnly() |
void |
setAbandoned(boolean abandoned) |
void |
setAliasDerefMode(org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefMode) |
void |
setAllOperationalAttributes(boolean allOperationalAttribute) |
void |
setAllUserAttributes(boolean allUserAttributes) |
void |
setNoAttributes(boolean noAttributes) |
protected void |
setReturningAttributes(Collection<String> attributesIds) |
void |
setReturningAttributes(Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes) |
protected void |
setReturningAttributes(String[] attributesIds) |
void |
setScope(org.apache.directory.shared.ldap.filter.SearchScope scope) |
void |
setSizeLimit(long sizeLimit) |
void |
setTimeLimit(int timeLimit) |
void |
setTypesOnly(boolean typesOnly) |
String |
toString() |
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, ignoreReferral, isBypassed, isFirstOperation, isReferralIgnored, isReferralThrown, lookup, lookup, modify, newLookupContext, setAuthorizedPrincipal, setByPassed, setDn, setEntry, setNextOperation, setPreviousOperation, setRequestControls, setSession, throwReferral
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 Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes
protected boolean abandoned
protected boolean typesOnly
public SearchingOperationContext(CoreSession session)
public SearchingOperationContext(CoreSession session, org.apache.directory.shared.ldap.name.DN dn)
dn
- The DN to get the suffix frompublic SearchingOperationContext(CoreSession session, org.apache.directory.shared.ldap.name.DN dn, Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes)
dn
- The DN to get the suffix fromaliasDerefMode
- the alias dereferencing mode to useNamingException
protected void setReturningAttributes(Collection<String> attributesIds) throws Exception
Exception
protected void setReturningAttributes(String[] attributesIds) throws Exception
Exception
public String toString()
toString
in class Object
Object.toString()
public org.apache.directory.shared.ldap.message.AliasDerefMode getAliasDerefMode()
public void setAliasDerefMode(org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefMode)
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 boolean isTypesOnly()
public void setTypesOnly(boolean typesOnly)
public void setReturningAttributes(Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> returningAttributes)
returningAttributes
- the returningAttributes to setpublic Set<org.apache.directory.shared.ldap.schema.AttributeTypeOptions> getReturningAttributes()
public SearchControls getSearchControls()
public SearchControls getSearchControls(boolean denormalized)
denormalized
- true if attribute values are not normalizedpublic void setAbandoned(boolean abandoned)
abandoned
- the abandoned to setpublic boolean isAbandoned()
Copyright © 2003-2013 Apache Software Foundation. All Rights Reserved.