|
Oracle® Ultra Search Java API Reference 11g Release 1 (11.1) B28329-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CrawlerAgent
CrawlerAgent is an interface used by a crawler agent to submit URL-related data to the crawler.
Method Summary | |
---|---|
void |
close() Shut down the agent |
UrlData |
fetch() Retrieve the next document URL data |
boolean |
getAttributeLOVs(LovInfo lovNode) Get the list of values (LOV) for the attributes of this data source |
java.lang.String |
getCookies(java.lang.String host, java.lang.String realm, java.lang.String url) Deprecated. since 9.0.2 |
java.lang.String |
getCredential(java.lang.String host, java.lang.String realm, java.lang.String url) Get the user name and password of the specified URL |
boolean |
isDeltaCrawlingCapable() Ask if this agent can return only URLs updated since the last crawl |
void |
open(DataSourceParams params) Initialize the agent |
void |
received(UrlData urlNode) Acknowledge that the urlNode sent from the fetch method has been received |
void |
startCrawling(boolean forceRecrawl, java.util.Date lastCrawlTIme) Ask the agent to prepare for fetching of document URL and its attribute from the data source. |
void |
stopCrawling() Tell the agent to stop crawling; no more fetching request. |
Method Detail |
---|
void open(DataSourceParams params) throws AgentException
params
- the data source parametersAgentException
- if unable to initialize the agentboolean isDeltaCrawlingCapable()
void startCrawling(boolean forceRecrawl, java.util.Date lastCrawlTIme) throws AgentException
forceRecrawl
- a flag asking agent to return all URLs if truelastCrawlTime
- the time last crawling was performedAgentException
- if unable to get ready for fetchingvoid stopCrawling() throws AgentException
AgentException
- if agent is unable to stop crawlingUrlData fetch() throws AgentException
AgentException
- if unable to fetchvoid received(UrlData urlNode)
java.lang.String getCredential(java.lang.String host, java.lang.String realm, java.lang.String url)
host
- the host name of the URLrealm
- the protection realmurl
- the URL string where user name and password is neededjava.lang.String getCookies(java.lang.String host, java.lang.String realm, java.lang.String url)
host
- the host name of the URLrealm
- the protection realmurl
- the URL that needs the authentication informationboolean getAttributeLOVs(LovInfo lovNode) throws AgentException
lovNode
- the container object to store the attribute LOVsAgentException
- if getting any unknown errorvoid close() throws AgentException
AgentException
- if unable to close the agent
|
Oracle® Ultra Search Java API Reference 11g Release 1 (11.1) B28329-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |