Package org.lockss.laaws.crawler.impl

Class JobsApiServiceImpl

java.lang.Object

org.lockss.spring.base.BaseSpringApiServiceImpl

org.lockss.laaws.crawler.impl.JobsApiServiceImpl

All Implemented Interfaces:

JobsApiDelegate

@Service
public class JobsApiServiceImpl
extends BaseSpringApiServiceImpl
implements JobsApiDelegate

Nested Class Summary

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

BaseSpringApiServiceImpl.MapMessageListener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AU_HAS_QUEUED_OR_ACTIVE_CRAWL

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	Description
JobsApiServiceImpl(jakarta.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob>	deleteCrawlJob(String jobId)	Deletes a crawl previously added to the crawl queue, stopping the crawl if already running.
org.springframework.http.ResponseEntity<Void>	deleteJobs()	Deletes all the currently queued and active crawl requests.
org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob>	getCrawlJob(String jobId)	Provides the status of a requested crawl.
org.springframework.http.ResponseEntity<JobPager>	getJobs(Integer limit, String continuationToken)	Get all crawl jobs
org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob>	queueJob(org.lockss.util.rest.crawler.CrawlDesc crawlDesc)	Requests a crawl.

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.JobsApiDelegate

getAcceptHeader, getObjectMapper, getRequest

Field Details

AU_HAS_QUEUED_OR_ACTIVE_CRAWL

public static final String AU_HAS_QUEUED_OR_ACTIVE_CRAWL

See Also:

• Constant Field Values

Constructor Details

JobsApiServiceImpl

@Autowired
public JobsApiServiceImpl(jakarta.servlet.http.HttpServletRequest request)

Method Details

getJobs

public org.springframework.http.ResponseEntity<JobPager> getJobs(Integer limit,
 String continuationToken)

Get all crawl jobs

Specified by:

getJobs in interface JobsApiDelegate

See Also:

• JobsApi.getJobs(java.lang.Integer, java.lang.String)

deleteJobs

public org.springframework.http.ResponseEntity<Void> deleteJobs()

Deletes all the currently queued and active crawl requests.

Specified by:

deleteJobs in interface JobsApiDelegate

Returns:

a ResponseEntity<Void>.

See Also:

• JobsApi.deleteJobs()

queueJob

public org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob> queueJob(org.lockss.util.rest.crawler.CrawlDesc crawlDesc)

Requests a crawl.

Specified by:

queueJob in interface JobsApiDelegate

Parameters:

crawlDesc - A CrawlDesc with the information about the requested crawl.

Returns:

a ResponseEntity<CrawlJob> with the information about the job created to perform the crawl.

See Also:

• JobsApi.queueJob(org.lockss.util.rest.crawler.CrawlDesc)

getCrawlJob

public org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob> getCrawlJob(String jobId)

Provides the status of a requested crawl.

Specified by:

getCrawlJob in interface JobsApiDelegate

Parameters:

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

Returns:

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

See Also:

• JobsApi.getCrawlJob(java.lang.String)

deleteCrawlJob

public org.springframework.http.ResponseEntity<org.lockss.util.rest.crawler.CrawlJob> deleteCrawlJob(String jobId)

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

Specified by:

deleteCrawlJob in interface JobsApiDelegate

Parameters:

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

Returns:

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

See Also:

• JobsApi.deleteCrawlJob(String)