Skip navigation links

oracle.search.sdk.crawler
Interface QueueService

public interface QueueService

QueueService is an interface used by a crawler plugin to submit or retrieve URL-related data.

Field Summary

static int	FIFO to de-queue documents in the same order as en-queued
static int	LIFO to de-queue documents in reverse order as en-queued
static int	UNORDERED to de-queue documents in no specific order

Method Summary

void	deleteDocument(String displayURL) remove a document from the queue with the specified display URL
int	enqueue(DocumentMetadata docNode) If the display URL does not exist in the data source, it is created and put into the queue.
int	enqueue(String displayUrl, String accessUrl, int depth) If the display URL does not exist in the data source, it is created and put into the queue.
void	enqueueExistingURLs()
void	enqueueExistingURLs(int statusCode)
void	enqueueNotIndexedURLs()
DocumentMetadata	getNextItem()
int	getQueueSize() get the size of the queue
boolean	isEnqueued(String displayURL) check whether the given URL is in the queue or not
boolean	isQueueEmpty()
void	purgeQueue() clean up the queue
void	purgeQueue(int statusCode)
void	removeUrlNotInQueue()
void	stopQueueService()

Field Detail

UNORDERED

static final int UNORDERED

to de-queue documents in no specific order

See Also:

Constant Field Values

FIFO

static final int FIFO

to de-queue documents in the same order as en-queued

See Also:

Constant Field Values

LIFO

static final int LIFO

to de-queue documents in reverse order as en-queued

See Also:

Constant Field Values

Method Detail

enqueue

int enqueue(DocumentMetadata docNode)

• If the display URL does not exist in the data source, it is created and put into the queue.
• If the display URL is already in the queue then no operation is performed.
• If the display URL is not in the queue but exists in the current data source, then it is returned to the queue. Be careful about the possibility of a URL being put into the queue, processed, and then being put into the queue again.

Parameters:

docNode - the document metadata

Returns:

0 if the queueing is successful, or 1 if this document is already in the queue.

enqueue

int enqueue(String displayUrl,
            String accessUrl,
            int depth)

• If the display URL does not exist in the data source, it is created and put into the queue.
• If the display URL is already in the queue then no operation is performed.
• If the display URL is not in the queue but exist in the current data source then it is returned to the queue. Be careful about the possibility of a URL being put into the queue, processed, and then being put into the queue again.

Parameters:

displayUrl - - the display URL

accessUrl - - the access URL, which can be null

depth - - the depth of the document

Returns:

0 if the queueing is successful, or 1 if this document is already in the queue.

enqueueExistingURLs

void enqueueExistingURLs()

enqueueExistingURLs

void enqueueExistingURLs(int statusCode)

Parameters:

statusCode - the document status code

enqueueNotIndexedURLs

void enqueueNotIndexedURLs()

isQueueEmpty

boolean isQueueEmpty()

Returns:

A value of true if the queue is empty, or false if not.

isEnqueued

boolean isEnqueued(String displayURL)

check whether the given URL is in the queue or not

Returns:

true if the URL exist in the queue, false if not

getNextItem

DocumentMetadata getNextItem()

getQueueSize

int getQueueSize()

get the size of the queue

Returns:

the queue size

purgeQueue

void purgeQueue()

clean up the queue

purgeQueue

void purgeQueue(int statusCode)

Parameters:

statusCode - the document status code

deleteDocument

void deleteDocument(String displayURL)

remove a document from the queue with the specified display URL

Parameters:

displayURL - the document display URL

stopQueueService

void stopQueueService()

removeUrlNotInQueue

void removeUrlNotInQueue()

Skip navigation links