|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.services.ldap.model.LDAPRequest | +--com.ibm.dse.services.ldap.model.LDAPSearchRequest
This class supports the search request to the LDAP Composer service.
Field Summary | |
static int |
OBJECT_SCOPE
|
static int |
ONELEVEL_SCOPE
|
static int |
SUBTREE_SCOPE
|
Fields inherited from class com.ibm.dse.services.ldap.model.LDAPRequest |
COMPID,
requestType |
Constructor Summary | |
LDAPSearchRequest()
LDAPSearchRequest constructor. |
Method Summary | |
void |
addAttributeToMatch(javax.naming.directory.Attribute attribute)
A utility method used to manage the list of attributes used to contruct a filter. |
void |
addAttributeToMatch(java.lang.String key,
java.lang.Object value)
A utility method used to manage the list of attributes used to contruct a filter. |
void |
addAttributeToReturn(java.lang.String attributeName)
A utility method used to manage the list of attributes to return. |
void |
addFilterArgument(java.lang.Object argument)
A utility method used to manage the list of filter objects. |
java.lang.String |
getFilter()
Return the filter string used by this search request. |
java.lang.String |
getFilterExpression()
Return the filter expression used to carry out this search request. |
java.lang.Object[] |
getFilterObjects()
Return the filter objects used to dynamically build a filter list. |
java.lang.String |
getFilterType()
Return the type of filter in use by this request. |
boolean |
getFollowReferences()
Returns the value of the flag used to determine the behaviour of the LDAP server when it encounters referrals. |
javax.naming.directory.Attributes |
getMatchingAttributes()
Returns the list of attributes used to build a filter. |
long |
getMaxHits()
Returns the value set for the maximum number of results to be returned in response to this search request. |
java.lang.String[] |
getReturningAttributes()
Returns the list of attributes that are desired to be returned with the request's response data. |
boolean |
getReturnObjects()
Returns the present value of the flag that determines whether the LDAP server will return objects as part of its response. |
javax.naming.directory.SearchControls |
getSearchControls()
Returns the current search control object for this request. |
int |
getSearchScope()
Returns the present value for the search scope. |
int |
getTimeLimit()
Returns the present time limit set for this search request to run. |
void |
mapFromContext(Context context)
This method supports externalization of an LDAP search request. |
static int |
parseSearchScope(java.lang.String scope)
Given one of the following strings object, subtree, onelevel, this method returns a valid search scope. |
void |
removeAttributeToMatch(java.lang.String key)
A utility method for managing the list of attributes used to build a filter expression. |
void |
removeAttributeToReturn(java.lang.String attributeName)
A utility method for managing the list of attributes to return. |
void |
removeFilterArgument(java.lang.Object argument)
A utility method for managing the list of filter objects. |
void |
setFilter(java.lang.String newFilter)
Sets the filter to use to carry out this search request. |
void |
setFilterExpression(java.lang.String newFilterExpression)
Sets a filter expression for use in carrying out this search request. |
void |
setFilterObjects(java.lang.Object[] newFilterObjects)
Sets an array of object for use in conjunction with a filter expression. |
void |
setFilterType(java.lang.String newFilterType)
Used to specify the type of filter to use for carrying out this search request. |
void |
setFollowReferences(boolean newFollowReferences)
Sets the flag that controls the behaviour of the LDAP server when it encounters referrals. |
void |
setMatchingAttributes(javax.naming.directory.Attributes newMatchingAttributes)
The values specified in the javax.naming.directory.Attributes object passed into this method are used to contruct a filter for carrying out this search request. |
void |
setMaxHits(long newMaxHits)
Set the maximum number of results for the LDAP server to return in response to the search request. |
void |
setReturningAttributes(java.lang.String[] newReturningAttributes)
The array passed into this method should contain the names of attributes that the LDAP server should make an attempt to return. |
void |
setReturnObjects(boolean newReturnObjects)
Set a flag indicating whether the LDAP server should return directory objects along with its response data. |
void |
setSearchControls(javax.naming.directory.SearchControls controls)
Set a javax.naming.directory.SearchControls containing search parameters for this request. |
void |
setSearchScope(int newSearchScope)
Set the scope of this search. |
void |
setTimeLimit(int newTimeLimit)
Set the time limit for this search request |
Methods inherited from class com.ibm.dse.services.ldap.model.LDAPRequest |
getBooleanValue,
getIntValue,
getName,
getRequestType,
getValue,
setName,
setRequestType |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int OBJECT_SCOPE
public static final int ONELEVEL_SCOPE
public static final int SUBTREE_SCOPE
Constructor Detail |
public LDAPSearchRequest()
Method Detail |
public void addAttributeToMatch(java.lang.String key, java.lang.Object value)
key
- java.lang.Stringvalue
- java.lang.Objectpublic void addAttributeToMatch(javax.naming.directory.Attribute attribute)
attribute
- javax.naming.directory.Attributepublic void addAttributeToReturn(java.lang.String attributeName)
attributeName
- java.lang.Stringpublic void addFilterArgument(java.lang.Object argument)
argument
- java.lang.Objectpublic java.lang.String getFilter()
public java.lang.String getFilterExpression()
public java.lang.Object[] getFilterObjects()
public java.lang.String getFilterType()
public boolean getFollowReferences()
public javax.naming.directory.Attributes getMatchingAttributes()
public long getMaxHits()
public java.lang.String[] getReturningAttributes()
public boolean getReturnObjects()
public javax.naming.directory.SearchControls getSearchControls()
public int getSearchScope()
public int getTimeLimit()
public void mapFromContext(Context context) throws DSEException
context
- com.ibm.dse.base.Contextpublic static int parseSearchScope(java.lang.String scope) throws DSEException
scope
- java.lang.Stringpublic void removeAttributeToMatch(java.lang.String key)
key
- java.lang.Stringpublic void removeAttributeToReturn(java.lang.String attributeName)
attributeName
- java.lang.Stringpublic void removeFilterArgument(java.lang.Object argument)
argument
- java.lang.Objectpublic void setFilter(java.lang.String newFilter)
newFilter
- java.lang.Stringpublic void setFilterExpression(java.lang.String newFilterExpression)
newFilterExpression
- java.lang.Stringpublic void setFilterObjects(java.lang.Object[] newFilterObjects)
newFilterObjects
- java.lang.Object[]public void setFilterType(java.lang.String newFilterType)
newFilterType
- java.lang.Stringpublic void setFollowReferences(boolean newFollowReferences)
newFollowReferences
- booleanpublic void setMatchingAttributes(javax.naming.directory.Attributes newMatchingAttributes)
newMatchingAttributes
- javax.naming.directory.Attributespublic void setMaxHits(long newMaxHits)
newMaxHits
- longpublic void setReturningAttributes(java.lang.String[] newReturningAttributes)
newReturningAttributes
- java.lang.String[]public void setReturnObjects(boolean newReturnObjects)
newReturnObjects
- booleanpublic void setSearchControls(javax.naming.directory.SearchControls controls)
controls
- javax.naming.directory.SearchControlspublic void setSearchScope(int newSearchScope)
newSearchScope
- intpublic void setTimeLimit(int newTimeLimit)
newTimeLimit
- int
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |