|
Sun Adapter for LDAP API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.stc.connector.ldapadapter.appconn.PersistentSearchImpl
public class PersistentSearchImpl
This class is used to implement the Persistent Search mechanism. It registers a listener to the LDAP server based on the parameters received from the user.
| Constructor Summary | |
|---|---|
PersistentSearchImpl(LDAPClientApplicationImpl app)
Creates a new instance of PersistentSearch |
|
| Method Summary | |
|---|---|
java.lang.String |
getContextName()
Method to retrieve the context name on which the listener is listening |
java.lang.String |
getEntryName()
Method to retrieve the entry name on which the listener is interested. |
STCEventQueue |
getEventQueue()
Method to retrieve the event queue associated with this search operation |
java.lang.String |
getSearchFilter()
Method to retrieve the search filter that was set for this search operation |
int |
getSearchScope()
Method to retrieve the search scope that was set for this search operation |
void |
reset()
Method to reset the values |
void |
search()
Method that is invoked by the client to initiate a Persistent Search. |
void |
setContextName(java.lang.String contextName)
Method to set the context name on which the listener should listening |
void |
setEntryName(java.lang.String entryName)
Method to set the entry name on which the listener is interested. |
void |
setSearchFilter(java.lang.String searchFilter)
Method to set the search filter for this search operation |
void |
setSearchScope(int searchScope)
Method to set the search scope for this search operation |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PersistentSearchImpl(LDAPClientApplicationImpl app)
app - The LDAP client application associated with this PersistentSearch
instance.| Method Detail |
|---|
public void reset()
PersistentSearch
reset in interface PersistentSearch
public int getSearchScope()
throws LDAPApplicationException
getSearchScope in interface PersistentSearchLDAPApplicationException - if there is no connection is available to the LDAP server.
public void setSearchScope(int searchScope)
throws LDAPApplicationException
setSearchScope in interface PersistentSearchthe - integer value representing the search scope set
LDAPApplicationException - if there is no connection is available to the LDAP server.
public java.lang.String getContextName()
throws LDAPApplicationException
getContextName in interface PersistentSearchLDAPApplicationException - if there is no connection is available to the LDAP server.
public void setContextName(java.lang.String contextName)
throws LDAPApplicationException
setContextName in interface PersistentSearchthe - context name on which the listener should be listening for updates
LDAPApplicationException - if there is no connection is available to the LDAP server.
public java.lang.String getEntryName()
throws LDAPApplicationException
getEntryName in interface PersistentSearchLDAPApplicationException - if there is no connection is available to the LDAP server.
public void setEntryName(java.lang.String entryName)
throws LDAPApplicationException
setEntryName in interface PersistentSearchthe - entry name on which the listener is interested for updates
LDAPApplicationException - if there is no connection is available to the LDAP server.
public java.lang.String getSearchFilter()
throws LDAPApplicationException
getSearchFilter in interface PersistentSearchLDAPApplicationException - if there is no connection is available to the LDAP server.
public void setSearchFilter(java.lang.String searchFilter)
throws LDAPApplicationException
setSearchFilter in interface PersistentSearchthe - search filter that is to be set for this search operation
LDAPApplicationException - if there is no connection is available to the LDAP server.
public STCEventQueue getEventQueue()
throws LDAPApplicationException
getEventQueue in interface PersistentSearchLDAPApplicationException - if there is no connection is available to the LDAP server.
public void search()
throws LDAPApplicationException
search in interface PersistentSearchLDAPApplicationException - if there is no connection is available to the LDAP server.
|
Sun Adapter for LDAP API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||