org.archive.crawler.prefetch

Enum RuntimeLimitEnforcer.Operation

java.lang.Object

java.lang.Enum<RuntimeLimitEnforcer.Operation>

org.archive.crawler.prefetch.RuntimeLimitEnforcer.Operation

All Implemented Interfaces:

Serializable, Comparable<RuntimeLimitEnforcer.Operation>

Enclosing class:

RuntimeLimitEnforcer

public static enum RuntimeLimitEnforcer.Operation
extends Enum<RuntimeLimitEnforcer.Operation>

The action that the processor takes once the runtime has elapsed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCK_URIS Blocks each URI with an -5002 (blocked by custom processor) fetch status code.
PAUSE Pauses the crawl.
TERMINATE Terminates the job.

Method Summary

Methods

Modifier and Type	Method and Description
static RuntimeLimitEnforcer.Operation	valueOf(String name) Returns the enum constant of this type with the specified name.
static RuntimeLimitEnforcer.Operation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PAUSE

public static final RuntimeLimitEnforcer.Operation PAUSE

Pauses the crawl. A change (increase) to the runtime duration will make it pausible to resume the crawl. Attempts to resume the crawl without modifying the run time will cause it to be immediately paused again.

TERMINATE

public static final RuntimeLimitEnforcer.Operation TERMINATE

Terminates the job. Equivalent to using the max-time setting on the CrawlController.

BLOCK_URIS

public static final RuntimeLimitEnforcer.Operation BLOCK_URIS

Blocks each URI with an -5002 (blocked by custom processor) fetch status code. This will cause all the URIs queued to wind up in the crawl.log.

Method Detail

values

public static RuntimeLimitEnforcer.Operation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RuntimeLimitEnforcer.Operation c : RuntimeLimitEnforcer.Operation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RuntimeLimitEnforcer.Operation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null