org.lockss.laaws.crawler.impl

Class CrawlsApiServiceImpl

java.lang.Object

org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.laaws.crawler.impl.CrawlsApiServiceImpl

All Implemented Interfaces:

CrawlsApiDelegate

@Service
public class CrawlsApiServiceImpl
extends BaseSpringApiServiceImpl
implements CrawlsApiDelegate

Service for accessing crawls.

Nested Class Summary

Nested classes/interfaces inherited from class org.lockss.spring.base.BaseSpringApiServiceImpl

BaseSpringApiServiceImpl.MapMessageListener

Field Summary

Fields inherited from class org.lockss.spring.base.BaseSpringApiServiceImpl

DEFAULT_CONFIG_WAIT_TIME, DEFAULT_READY_WAIT_TIME, JMS_BOTH, JMS_RECEIVE, JMS_SEND, jmsConsumer, jmsProducer, PARAM_CONFIG_WAIT_TIME, PARAM_READY_WAIT_TIME

Constructor Summary

Constructors

Constructor and Description
CrawlsApiServiceImpl(javax.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<CrawlStatus>	deleteCrawlById(String jobId) Deletes a crawl previously added to the crawl queue, stopping the crawl if already running.
org.springframework.http.ResponseEntity<CrawlStatus>	getCrawlById(String jobId) Provides the status of a requested crawl.
org.springframework.http.ResponseEntity<UrlPager>	getCrawlByMimeType(String jobId, String type, Integer limit, String continuationToken) Returns all (or a pageful of) the items in a crawl by MIME type..
org.springframework.http.ResponseEntity<UrlPager>	getCrawlErrors(String jobId, Integer limit, String continuationToken) Returns all (or a pageful of) the error URLS in a crawl.
org.springframework.http.ResponseEntity<UrlPager>	getCrawlExcluded(String jobId, Integer limit, String continuationToken) Returns all (or a pageful of) the excluded URLS in a crawl.
org.springframework.http.ResponseEntity<UrlPager>	getCrawlFetched(String jobId, Integer limit, String continuationToken) Returns all (or a pageful of) the fetched URLS in a crawl.
org.springframework.http.ResponseEntity<UrlPager>	getCrawlNotModified(String jobId, Integer limit, String continuationToken) Returns all (or a pageful of) the not-modified URLS in a crawl.
org.springframework.http.ResponseEntity<UrlPager>	getCrawlParsed(String jobId, Integer limit, String continuationToken) Returns all (or a pageful of) the parsed URLS in a crawl.
org.springframework.http.ResponseEntity<UrlPager>	getCrawlPending(String jobId, Integer limit, String continuationToken) Returns all (or a pageful of) the pending URLS in a crawl.
org.springframework.http.ResponseEntity<CrawlPager>	getCrawls(Integer limit, String continuationToken) Provides all (or a pageful of) the crawls in the service.

Methods inherited from class org.lockss.spring.base.BaseSpringApiServiceImpl

configMgrCreated, getClassName, getConfigWaitTime, getJMSManager, getPluginManager, getReadyWaitTime, getRunningLockssDaemon, getStateManager, getWaitTime, jmsSetUpDone, jsonResponse, receiveMessage, registerConfigCallback, setUpJms, setUpJms, setUpJms, stopJms, stringResponse, waitConfig, waitConfig, waitReady, waitReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.lockss.laaws.crawler.api.CrawlsApiDelegate

getAcceptHeader, getObjectMapper, getRequest

Constructor Detail

CrawlsApiServiceImpl

@Autowired
public CrawlsApiServiceImpl(javax.servlet.http.HttpServletRequest request)

Method Detail

deleteCrawlById

public org.springframework.http.ResponseEntity<CrawlStatus> deleteCrawlById(String jobId)

Deletes a crawl previously added to the crawl queue, stopping the crawl if already running.

Specified by:

deleteCrawlById in interface CrawlsApiDelegate

Parameters:

jobId - A String with the identifier assigned to the crawl when added.

Returns:

a ResponseEntity<CrawlStatus> with the status of the deleted crawl.

See Also:

CrawlsApi.deleteCrawlById(java.lang.String)

getCrawlById

public org.springframework.http.ResponseEntity<CrawlStatus> getCrawlById(String jobId)

Provides the status of a requested crawl.

Specified by:

getCrawlById in interface CrawlsApiDelegate

Parameters:

jobId - A String with the identifier assigned to the crawl when added.

Returns:

a ResponseEntity<CrawlStatus> with the status of the crawl.

See Also:

CrawlsApi.getCrawlById(java.lang.String)

getCrawlByMimeType

public org.springframework.http.ResponseEntity<UrlPager> getCrawlByMimeType(String jobId,
                                                                            String type,
                                                                            Integer limit,
                                                                            String continuationToken)

Returns all (or a pageful of) the items in a crawl by MIME type..

Specified by:

getCrawlByMimeType in interface CrawlsApiDelegate

Parameters:

jobId - A String with the identifier assigned to the crawl when added.

type - A String with the MIME type.

limit - An Integer with the maximum number of URLs per s page.

continuationToken - A String with the continuation token used to fetch the next page

Returns:

a ResponseEntity<UrlPager> with the information about the items.

See Also:

CrawlsApi.getCrawlByMimeType(java.lang.String, java.lang.String, java.lang.Integer, java.lang.String)

getCrawlErrors

public org.springframework.http.ResponseEntity<UrlPager> getCrawlErrors(String jobId,
                                                                        Integer limit,
                                                                        String continuationToken)

Returns all (or a pageful of) the error URLS in a crawl.

Specified by:

getCrawlErrors in interface CrawlsApiDelegate

Parameters:

jobId - A String with the identifier assigned to the crawl when added.

limit - An Integer with the maximum number of URLs per page.

continuationToken - A String with the continuation token used to fetch the next page

Returns:

a ResponseEntity<UrlPager> with the information about the error URLs.

See Also:

CrawlsApi.getCrawlErrors(java.lang.String, java.lang.Integer, java.lang.String)

getCrawlExcluded

public org.springframework.http.ResponseEntity<UrlPager> getCrawlExcluded(String jobId,
                                                                          Integer limit,
                                                                          String continuationToken)

Returns all (or a pageful of) the excluded URLS in a crawl.

Specified by:

getCrawlExcluded in interface CrawlsApiDelegate

Parameters:

jobId - A String with the identifier assigned to the crawl when added.

limit - An Integer with the maximum number of URLs per page.

continuationToken - A String with the continuation token used to fetch the next page

Returns:

a ResponseEntity<UrlPager> with the information about the excluded URLs.

See Also:

CrawlsApi.getCrawlExcluded(java.lang.String, java.lang.Integer, java.lang.String)

getCrawlFetched

public org.springframework.http.ResponseEntity<UrlPager> getCrawlFetched(String jobId,
                                                                         Integer limit,
                                                                         String continuationToken)

Returns all (or a pageful of) the fetched URLS in a crawl.

Specified by:

getCrawlFetched in interface CrawlsApiDelegate

Parameters:

jobId - A String with the identifier assigned to the crawl when added.

limit - An Integer with the maximum number of URLs per page.

continuationToken - A String with the continuation token used to fetch the next page

Returns:

a ResponseEntity<UrlPager> with the information about the fetched URLs.

See Also:

CrawlsApi.getCrawlFetched(java.lang.String, java.lang.Integer, java.lang.String)

getCrawlNotModified

public org.springframework.http.ResponseEntity<UrlPager> getCrawlNotModified(String jobId,
                                                                             Integer limit,
                                                                             String continuationToken)

Returns all (or a pageful of) the not-modified URLS in a crawl.

Specified by:

getCrawlNotModified in interface CrawlsApiDelegate

Parameters:

jobId - A String with the identifier assigned to the crawl when added.

limit - An Integer with the maximum number of URLs per page.

continuationToken - A String with the continuation token used to fetch the next page

Returns:

a ResponseEntity<UrlPager> with the information about the not-modified URLs.

See Also:

CrawlsApi.getCrawlNotModified(java.lang.String, java.lang.Integer, java.lang.String)

getCrawlParsed

public org.springframework.http.ResponseEntity<UrlPager> getCrawlParsed(String jobId,
                                                                        Integer limit,
                                                                        String continuationToken)

Returns all (or a pageful of) the parsed URLS in a crawl.

Specified by:

getCrawlParsed in interface CrawlsApiDelegate

Parameters:

jobId - A String with the identifier assigned to the crawl when added.

limit - An Integer with the maximum number of URLs per page.

continuationToken - A String with the continuation token used to fetch the next page

Returns:

a ResponseEntity<UrlPager> with the information about the parsed URLs.

See Also:

CrawlsApi.getCrawlParsed(java.lang.String, java.lang.Integer, java.lang.String)

getCrawlPending

public org.springframework.http.ResponseEntity<UrlPager> getCrawlPending(String jobId,
                                                                         Integer limit,
                                                                         String continuationToken)

Returns all (or a pageful of) the pending URLS in a crawl.

Specified by:

getCrawlPending in interface CrawlsApiDelegate

Parameters:

jobId - A String with the identifier assigned to the crawl when added.

limit - An Integer with the maximum number of URLs per page.

continuationToken - A String with the continuation token used to fetch the next page

Returns:

a ResponseEntity<UrlPager> with the information about the pending URLs.

See Also:

CrawlsApi.getCrawlPending(java.lang.String, java.lang.Integer, java.lang.String)

getCrawls

public org.springframework.http.ResponseEntity<CrawlPager> getCrawls(Integer limit,
                                                                     String continuationToken)

Provides all (or a pageful of) the crawls in the service.

Specified by:

getCrawls in interface CrawlsApiDelegate

Parameters:

limit - An Integer with the maximum number of crawls per page.

continuationToken - A String with the continuation token used to fetch the next page

Returns:

a ResponseEntity<CrawlPager> with the information about the crawls.

See Also:

CrawlsApi.getCrawls(java.lang.Integer, java.lang.String)