|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CasCrawler
Provides the public interface to CAS Server. This interface includes:
Method Summary | |
---|---|
List<ConfigurationMessage> |
createCrawl(CrawlConfig crawlConfig)
Creates a crawl on the server. |
void |
deleteCrawl(CrawlId crawlId)
Deletes a crawl from the server. |
List<CrawlMetrics> |
getAllMetrics()
Gets a list of all metrics for all crawls on the server. |
List<ModuleSpec> |
getAllModuleSpecs(ModuleType moduleType)
Gets a list of specifications for modules available on the server that match the requested module type. |
CrawlConfig |
getCrawlConfig(CrawlId crawlId,
Boolean fillInDefaults)
Gets configuration for a particular crawl. |
List<Metric> |
getMetrics(CrawlId crawlId)
Gets metrics for a particular crawl. |
ModuleSpec |
getModuleSpec(ModuleId moduleId)
Gets information on how to configure a particular module. |
List<ModuleInfo> |
getNonIncrementalManipulators(CrawlId crawlId)
Returns the ModuleInfos of the manipulators in the given crawl that do no support incremental acquisition. |
List<Property> |
getServerInfo()
Returns information about the server, including version number. |
Status |
getStatus(CrawlId crawlId)
Gets status for a particular crawl. |
List<CrawlId> |
listCrawls()
Gets a list of crawls available on the server |
List<ModuleInfo> |
listModules(ModuleType moduleType)
Gets a list of modules available on the server that match the requested module type. |
void |
startCrawl(CrawlId crawlId,
CrawlMode crawlMode)
Starts a particular crawl. |
void |
stopCrawl(CrawlId crawlId)
Stops a crawl. |
List<ConfigurationMessage> |
updateCrawl(CrawlConfig crawlConfig)
Updates a crawl that already exists on the server. |
Method Detail |
---|
@ResponseWrapper(className="com.endeca.itl.cas.api.GetServerInfoResponse") List<Property> getServerInfo()
@ResponseWrapper(className="com.endeca.itl.cas.api.ListModulesResponse") List<ModuleInfo> listModules(ModuleType moduleType)
moduleType
- of modules to list.
ModuleSpec getModuleSpec(ModuleId moduleId) throws ModuleNotFoundException
moduleId
- of the module
ModuleNotFoundException
- if module is not available on the server.@ResponseWrapper(className="com.endeca.itl.cas.api.GetAllModuleSpecsResponse") List<ModuleSpec> getAllModuleSpecs(ModuleType moduleType)
moduleType
- of module specs to list
@ResponseWrapper(className="com.endeca.itl.cas.api.ListCrawlsResponse") List<CrawlId> listCrawls()
CrawlConfig getCrawlConfig(CrawlId crawlId, Boolean fillInDefaults) throws CrawlNotFoundException
crawlId
- of crawlfillInDefaults
- set to true if configuration should be populated with
default values for those parameters that have them.
CrawlNotFoundException
- if crawl does not exist@ResponseWrapper(className="com.endeca.itl.cas.api.CrawlConfigurationResponse") List<ConfigurationMessage> createCrawl(CrawlConfig crawlConfig) throws InvalidCrawlConfigException, CrawlAlreadyExistsException
crawlConfig
- configuration of crawl to create
InvalidCrawlConfigException
- if configuration is invalid.
CrawlAlreadyExistsException
- if crawl already exists on the server.@ResponseWrapper(className="com.endeca.itl.cas.api.CrawlConfigurationResponse") List<ConfigurationMessage> updateCrawl(CrawlConfig crawlConfig) throws CrawlNotFoundException, CrawlInProgressException, InvalidCrawlConfigException
crawlConfig
- updated config to replace that on the server.
CrawlNotFoundException
- if crawl does not already exist on the server.
CrawlInProgressException
- if crawl is currently running.
InvalidCrawlConfigException
- if there are validation errors in the
config being submitted. If so, the configuration of the crawl remains unchanged,
and the exception contains information about the particular validation errors
encountered.void deleteCrawl(CrawlId crawlId) throws CrawlNotFoundException, CrawlInProgressException, ItlException
crawlId
- of crawl
CrawlNotFoundException
- if crawl does not exist on the server
CrawlInProgressException
- if crawl is currently running
ItlException
- if internal exception was encountered by the server.@ResponseWrapper(className="com.endeca.itl.cas.api.GetNonIncrementalManipulatorsResponse") List<ModuleInfo> getNonIncrementalManipulators(CrawlId crawlId) throws CrawlNotFoundException
crawlId
-
CrawlNotFoundException
- if crawl does not already exist on the server.void startCrawl(CrawlId crawlId, CrawlMode crawlMode) throws CrawlNotFoundException, CrawlInProgressException, InvalidCrawlConfigException, ItlException
crawlId
- of the crawlcrawlMode
- the mode in which the crawl should be run (e.g. full or incremental)
CrawlNotFoundException
- if crawl does not exist
CrawlInProgressException
- if crawl is already running
InvalidCrawlConfigException
- if crawl's configuration is no longer valid. This can
happen, for example, if a particular module that is configured for the crawl has been uninstalled.
ItlException
- if a server-internal exception occurs in building or starting the crawl.void stopCrawl(CrawlId crawlId) throws CrawlNotFoundException
crawlId
- of crawl
CrawlNotFoundException
- if crawl does not exist on the serverStatus getStatus(CrawlId crawlId) throws CrawlNotFoundException
crawlId
- of crawl
CrawlNotFoundException
- if crawl does not exist.@ResponseWrapper(className="com.endeca.itl.cas.api.GetMetricsResponse") List<Metric> getMetrics(CrawlId crawlId) throws CrawlNotFoundException
crawlId
- of crawl
CrawlNotFoundException
- if crawl does not exist on the server@ResponseWrapper(className="com.endeca.itl.cas.api.GetAllMetricsResponse") List<CrawlMetrics> getAllMetrics()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |