A B C D E F G H I J L M N R S T U V W

A

abort() - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Aborts the running command.

AbstractJob - Class in com.norconex.jef4.job

Convenient base class for implementing jobs.

AbstractJob(String) - Constructor for class com.norconex.jef4.job.AbstractJob

Creates a new job.

AbstractJobGroup - Class in com.norconex.jef4.job.group

Base implementation for job groups.

AbstractJobGroup(String, IJob...) - Constructor for class com.norconex.jef4.job.group.AbstractJobGroup

Constructor.

AbstractJobLifeCycleListener - Class in com.norconex.jef4.job

Adapter for a job life-cycle.

AbstractJobLifeCycleListener() - Constructor for class com.norconex.jef4.job.AbstractJobLifeCycleListener

AbstractJobStateChangeListener - Class in com.norconex.jef4.job

Adapter for a job life-cycle, focusing on progress state changes.

AbstractJobStateChangeListener() - Constructor for class com.norconex.jef4.job.AbstractJobStateChangeListener

AbstractMailNotifier - Class in com.norconex.jef4.mail

Convenience base class for sending email notifications.

AbstractMailNotifier(String, String, String) - Constructor for class com.norconex.jef4.mail.AbstractMailNotifier

Constructor.

AbstractMailNotifier(String, String, String[]) - Constructor for class com.norconex.jef4.mail.AbstractMailNotifier

Constructor.

AbstractResumableJob - Class in com.norconex.jef4.job

Convenience class separating normal execution from recovery.

AbstractResumableJob() - Constructor for class com.norconex.jef4.job.AbstractResumableJob

Constructor.

AbstractSuiteLifeCycleListener - Class in com.norconex.jef4.suite

Adapter for a suite life-cycle listener.

AbstractSuiteLifeCycleListener() - Constructor for class com.norconex.jef4.suite.AbstractSuiteLifeCycleListener

accept(Exception) - Method in interface com.norconex.jef4.exec.IExceptionFilter

Deprecated.

Filters an exception.

accept(IJobStatusVisitor) - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

accept(IJobStatusVisitor) - Method in class com.norconex.jef4.suite.JobSuite

accept(IJobVisitor) - Method in class com.norconex.jef4.suite.JobSuite

Accepts a job suite visitor.

accept(IJobVisitor, Class<IJob>) - Method in class com.norconex.jef4.suite.JobSuite

Accepts a job suite visitor, filtering jobs and job progresses to those of the same type as the specified job class instance.

activateOptions() - Method in class com.norconex.jef4.log.ThreadSafeLayout

addErrorListener(IStreamListener) - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Adds an error (STDERR) listener to this system command.

addOutputListener(IStreamListener) - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Adds an output (STDOUT) listener to this system command.

AsyncJobGroup - Class in com.norconex.jef4.job.group

Job responsible for running a group of jobs asynchronously.

AsyncJobGroup(String, IJob...) - Constructor for class com.norconex.jef4.job.group.AsyncJobGroup

Constructor.

AsyncJobGroup(String, int, IJob...) - Constructor for class com.norconex.jef4.job.group.AsyncJobGroup

Constructor.

B

backup(String, Date) - Method in class com.norconex.jef4.log.FileLogManager

backup(String, Date) - Method in interface com.norconex.jef4.log.ILogManager

Backups the log for the given name space, and time stamps it with the given date.

backup(String, Date) - Method in class com.norconex.jef4.log.NoLogManager

backup(String, String, Date) - Method in class com.norconex.jef4.status.FileJobStatusStore

backup(String, String, Date) - Method in interface com.norconex.jef4.status.IJobStatusStore

Backups job progress.

C

com.norconex.jef4 - package com.norconex.jef4

Generic classes not belonging to any specific package.

com.norconex.jef4.exec - package com.norconex.jef4.exec

Utility classes related to process/code execution.

com.norconex.jef4.job - package com.norconex.jef4.job

Job-related classes.

com.norconex.jef4.job.group - package com.norconex.jef4.job.group

Classes related to the grouping of jobs.

com.norconex.jef4.log - package com.norconex.jef4.log

Classes related to logging.

com.norconex.jef4.mail - package com.norconex.jef4.mail

Optional package containing convenient classes for sending simple email notifications.

com.norconex.jef4.status - package com.norconex.jef4.status

Job-status related classes.

com.norconex.jef4.suite - package com.norconex.jef4.suite

Classes related to a job suite.

create(IJob, ILogManager) - Static method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

createAppender(String) - Method in class com.norconex.jef4.log.FileLogManager

createAppender(String) - Method in interface com.norconex.jef4.log.ILogManager

Creates a Log4J appender for the given name space.

createAppender(String) - Method in class com.norconex.jef4.log.NoLogManager

createJobSuite() - Method in interface com.norconex.jef4.suite.IJobSuiteFactory

Creates a job suite.

D

DEFAULT_MAX_RERUN_ATTEMPTS - Static variable in class com.norconex.jef4.exec.RetriableExecutor

Deprecated.

Default maximum number of retries.

DEFAULT_RERUN_SLEEP_TIME - Static variable in class com.norconex.jef4.exec.RetriableExecutor

Deprecated.

Default wait time (milliseconds) between reruns.

E

equals(Object) - Method in class com.norconex.jef4.log.FileLogManager

equals(Object) - Method in class com.norconex.jef4.log.NoLogManager

equals(Object) - Method in class com.norconex.jef4.status.FileJobStatusStore

equals(Object) - Method in class com.norconex.jef4.status.JobDuration

equals(Object) - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

equals(Object) - Method in class com.norconex.jef4.status.MutableJobStatus

ErrorMailNotifier - Class in com.norconex.jef4.mail

Simple error handler notifying email recipients when exceptions occur.

ErrorMailNotifier(String, String, String) - Constructor for class com.norconex.jef4.mail.ErrorMailNotifier

ErrorMailNotifier(String, String, String[]) - Constructor for class com.norconex.jef4.mail.ErrorMailNotifier

execute(IRetriable) - Method in class com.norconex.jef4.exec.RetriableExecutor

Deprecated.

Runs the IRetriable instance.

execute() - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Executes the given command and returns only when the underlying process stopped running.

execute(boolean) - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Executes the given system command.

execute(JobStatusUpdater, JobSuite) - Method in class com.norconex.jef4.exec.SystemCommandJob

execute(JobStatusUpdater, JobSuite) - Method in class com.norconex.jef4.job.AbstractResumableJob

execute(JobStatusUpdater, JobSuite) - Method in class com.norconex.jef4.job.group.AbstractJobGroup

execute(JobStatusUpdater, JobSuite) - Method in interface com.norconex.jef4.job.IJob

Executes this job.

execute() - Method in class com.norconex.jef4.suite.JobSuite

execute(boolean) - Method in class com.norconex.jef4.suite.JobSuite

executeGroup(JobSuite) - Method in class com.norconex.jef4.job.group.AbstractJobGroup

executeGroup(JobSuite) - Method in class com.norconex.jef4.job.group.AsyncJobGroup

executeGroup(JobSuite) - Method in class com.norconex.jef4.job.group.SyncJobGroup

ExecUtils - Class in com.norconex.jef4.exec

Deprecated.

Since 4.1.0, this class can be found in Norconex Commons Lang

F

FALLBACK_WORKDIR - Static variable in class com.norconex.jef4.JEFUtil

FileJobStatusStore - Class in com.norconex.jef4.status

File-based status store.

FileJobStatusStore() - Constructor for class com.norconex.jef4.status.FileJobStatusStore

FileJobStatusStore(String) - Constructor for class com.norconex.jef4.status.FileJobStatusStore

Creates a file-based job status serializer storing files in the given job directory.

FileLogManager - Class in com.norconex.jef4.log

Log manager using the file system to store its logs.

FileLogManager() - Constructor for class com.norconex.jef4.log.FileLogManager

Constructor using default log directory location.

FileLogManager(String) - Constructor for class com.norconex.jef4.log.FileLogManager

Creates a new FileLogManager, wrapping the given layout into a ThreadSafeLayout.

format(LoggingEvent) - Method in class com.norconex.jef4.log.ThreadSafeLayout

Calls the decorated instance, prefixing with job identifier.

G

getChildren(IJobStatus) - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

getChildren(String) - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

getCommand() - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Gets the command to be run.

getConfig() - Method in class com.norconex.jef4.suite.JobSuite

getCurrentJobId() - Static method in class com.norconex.jef4.suite.JobSuite

Gets the job identifier representing the currently running job for the current thread.

getDescription() - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Gets the description for this command.

getDuration() - Method in interface com.norconex.jef4.status.IJobStatus

getDuration() - Method in class com.norconex.jef4.status.JobDuration

Gets the elapsed time in milliseconds between the execution start and end time.

getDuration() - Method in class com.norconex.jef4.status.JobStatusUpdater

getDuration() - Method in class com.norconex.jef4.status.MutableJobStatus

getEndTime() - Method in class com.norconex.jef4.status.JobDuration

Gets the end time.

getException() - Method in class com.norconex.jef4.job.JobErrorEvent

Gets the exception behind this error.

getId() - Method in class com.norconex.jef4.exec.SystemCommandJob

getId() - Method in class com.norconex.jef4.job.AbstractJob

getId() - Method in class com.norconex.jef4.job.group.AbstractJobGroup

getId() - Method in interface com.norconex.jef4.job.IJob

Gets the job unique identifier.

getId() - Method in class com.norconex.jef4.suite.JobSuite

getJobErrorListeners() - Method in class com.norconex.jef4.suite.JobSuiteConfig

getJobId() - Method in interface com.norconex.jef4.status.IJobStatus

getJobId() - Method in class com.norconex.jef4.status.JobStatusUpdater

getJobId() - Method in class com.norconex.jef4.status.MutableJobStatus

getJobLifeCycleListeners() - Method in class com.norconex.jef4.suite.JobSuiteConfig

getJobs() - Method in class com.norconex.jef4.job.group.AbstractJobGroup

getJobs() - Method in interface com.norconex.jef4.job.group.IJobGroup

Gets all jobs part of this group.

getJobStatus(IJob) - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

getJobStatus(String) - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

getJobStatus(IJob) - Method in class com.norconex.jef4.suite.JobSuite

getJobStatus(String) - Method in class com.norconex.jef4.suite.JobSuite

getJobStatusList() - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

getJobStatusStore() - Method in class com.norconex.jef4.suite.JobSuiteConfig

getLastActivity() - Method in interface com.norconex.jef4.status.IJobStatus

getLastActivity() - Method in class com.norconex.jef4.status.MutableJobStatus

Gets the last activity.

getLog(String) - Method in class com.norconex.jef4.log.FileLogManager

getLog(String, String) - Method in class com.norconex.jef4.log.FileLogManager

getLog(String) - Method in interface com.norconex.jef4.log.ILogManager

Gets the log for the given namespace.

getLog(String, String) - Method in interface com.norconex.jef4.log.ILogManager

Gets the log for the given namespace and job identifier.

getLog(String) - Method in class com.norconex.jef4.log.NoLogManager

getLog(String, String) - Method in class com.norconex.jef4.log.NoLogManager

getLogDirectory() - Method in class com.norconex.jef4.log.FileLogManager

getLogFile(String) - Method in class com.norconex.jef4.log.FileLogManager

Gets the log file used by this log manager.

getLogManager() - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

getLogManager() - Method in class com.norconex.jef4.suite.JobSuite

getLogManager() - Method in class com.norconex.jef4.suite.JobSuiteConfig

Gets the Log4J log manager.

getLogTail(JobSuite, int) - Method in class com.norconex.jef4.mail.AbstractMailNotifier

Gets the last lines from a suite log.

getMailer() - Method in class com.norconex.jef4.mail.AbstractMailNotifier

Gets the mailer for this notifier.

getNote() - Method in interface com.norconex.jef4.status.IJobStatus

getNote() - Method in class com.norconex.jef4.status.MutableJobStatus

getParent(IJobStatus) - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

getParent(String) - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

getProgress() - Method in interface com.norconex.jef4.status.IJobStatus

getProgress() - Method in class com.norconex.jef4.status.JobStatusUpdater

getProgress() - Method in class com.norconex.jef4.status.MutableJobStatus

getProperties() - Method in interface com.norconex.jef4.status.IJobStatus

getProperties() - Method in class com.norconex.jef4.status.JobStatusUpdater

getProperties() - Method in class com.norconex.jef4.status.MutableJobStatus

getRecipients() - Method in class com.norconex.jef4.mail.AbstractMailNotifier

Gets the email recipients for this notifier.

getResumeAttempts() - Method in interface com.norconex.jef4.status.IJobStatus

getResumeAttempts() - Method in class com.norconex.jef4.status.MutableJobStatus

getResumedDuration() - Method in class com.norconex.jef4.status.JobDuration

getResumedLastActivity() - Method in class com.norconex.jef4.status.JobDuration

getResumedStartTime() - Method in class com.norconex.jef4.status.JobDuration

getRoot() - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

getRootJob() - Method in class com.norconex.jef4.suite.JobSuite

getStackTrace(Throwable) - Method in class com.norconex.jef4.mail.ErrorMailNotifier

getStartTime() - Method in class com.norconex.jef4.status.JobDuration

Gets the start time.

getState() - Method in interface com.norconex.jef4.status.IJobStatus

getState() - Method in class com.norconex.jef4.status.MutableJobStatus

Gets the job execution state.

getStatus() - Method in class com.norconex.jef4.job.JobErrorEvent

Gets the job progress of the job from which the error got triggered.

getStatus() - Method in class com.norconex.jef4.suite.JobSuite

Gets the job status for the root job.

getStatusDirectory() - Method in class com.norconex.jef4.status.FileJobStatusStore

getSuite() - Method in class com.norconex.jef4.job.JobErrorEvent

Gets the job suite from which this error occurred.

getSuiteIndexFile(String, String) - Static method in class com.norconex.jef4.JEFUtil

Gets the latest index file created for a job suite (if one exists).

getSuiteLifeCycleListeners() - Method in class com.norconex.jef4.suite.JobSuiteConfig

getTotalDuration() - Method in class com.norconex.jef4.status.JobDuration

Gets the elapsed time in milliseconds between the start date of the first elapsed time and the end of the last elapsed time.

getWorkdir() - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Gets the command working directory.

getWorkdir() - Method in class com.norconex.jef4.suite.JobSuite

getWorkdir() - Method in class com.norconex.jef4.suite.JobSuiteConfig

groupProgressed(IJobStatus) - Method in class com.norconex.jef4.job.group.AbstractJobGroup

groupProgressed(IJobStatus) - Method in interface com.norconex.jef4.job.group.IJobGroup

H

hashCode() - Method in class com.norconex.jef4.log.FileLogManager

hashCode() - Method in class com.norconex.jef4.log.NoLogManager

hashCode() - Method in class com.norconex.jef4.status.FileJobStatusStore

hashCode() - Method in class com.norconex.jef4.status.JobDuration

hashCode() - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

hashCode() - Method in class com.norconex.jef4.status.MutableJobStatus

HEARTBEAT_INTERVAL - Static variable in class com.norconex.jef4.suite.JobHeartbeatGenerator

I

IExceptionFilter - Interface in com.norconex.jef4.exec

Deprecated.

Since 4.1.0, this class can be found in Norconex Commons Lang

ignoresThrowable() - Method in class com.norconex.jef4.log.ThreadSafeLayout

IJob - Interface in com.norconex.jef4.job

A job to be executed by the Job Execution Framework.

IJobErrorListener - Interface in com.norconex.jef4.job

Job Execution Framework error listener.

IJobGroup - Interface in com.norconex.jef4.job.group

A job group is itself a job, with the added responsibility of managing the execution of other jobs.

IJobLifeCycleListener - Interface in com.norconex.jef4.job

Listener for job status events.

IJobStatus - Interface in com.norconex.jef4.status

IJobStatusStore - Interface in com.norconex.jef4.status

Responsible for serializing and deserializing a job status.

IJobStatusVisitor - Interface in com.norconex.jef4.status

Allows one to "visit" job statues and walk the status hierarchy with minimal effort (matching job hierarchy).

IJobSuiteFactory - Interface in com.norconex.jef4.suite

Job suites are an optional concept allowing to further abstract the job creation process.

IJobVisitor - Interface in com.norconex.jef4.job

Allows one to "visit" a job suite and walk its job hierarchy with minimal effort.

ILogManager - Interface in com.norconex.jef4.log

Class responsible for everything that relates to the underlying logging mechanism.

incrementProgress(double) - Method in class com.norconex.jef4.status.JobStatusUpdater

incrementResumeAttempts() - Method in class com.norconex.jef4.status.MutableJobStatus

IRetriable - Interface in com.norconex.jef4.exec

Deprecated.

Since 4.1.0, this class can be found in Norconex Commons Lang

isAborted() - Method in interface com.norconex.jef4.status.IJobStatus

isAborted() - Method in class com.norconex.jef4.status.MutableJobStatus

Checks whether the job was aborted or not (i.e.

isCompleted() - Method in interface com.norconex.jef4.status.IJobStatus

isCompleted() - Method in class com.norconex.jef4.status.MutableJobStatus

Checks whether the job execution has completed.

isOneOf(JobState...) - Method in enum com.norconex.jef4.status.JobState

isPrematurlyEnded() - Method in interface com.norconex.jef4.status.IJobStatus

isPrematurlyEnded() - Method in class com.norconex.jef4.status.MutableJobStatus

Checks whether the job ended before its time.

isResumed() - Method in interface com.norconex.jef4.status.IJobStatus

isResumed() - Method in class com.norconex.jef4.status.MutableJobStatus

Whether this status resumed from a previously failed or stopped job.

isRunning() - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Returns whether the command is currently running.

isRunning() - Method in interface com.norconex.jef4.status.IJobStatus

isRunning() - Method in class com.norconex.jef4.status.MutableJobStatus

Checks whether the job execution represented by this progress is still running.

isStarted() - Method in interface com.norconex.jef4.status.IJobStatus

isStarted() - Method in class com.norconex.jef4.status.MutableJobStatus

Checks whether the job was started or not.

isState(JobState...) - Method in interface com.norconex.jef4.status.IJobStatus

isState(JobState...) - Method in class com.norconex.jef4.status.MutableJobStatus

Checks whether the current progress status matches any of the supplied statuses.

isStopped() - Method in interface com.norconex.jef4.status.IJobStatus

isStopped() - Method in class com.norconex.jef4.status.MutableJobStatus

isStopping() - Method in interface com.norconex.jef4.status.IJobStatus

isStopping() - Method in class com.norconex.jef4.status.MutableJobStatus

isStopRequested() - Method in class com.norconex.jef4.status.MutableJobStatus

ISuiteLifeCycleListener - Interface in com.norconex.jef4.suite

Listener for life-cycle activities on a job suite.

J

JEFException - Exception in com.norconex.jef4

Represents a job-related exception.

JEFException(String) - Constructor for exception com.norconex.jef4.JEFException

JEFException(Throwable) - Constructor for exception com.norconex.jef4.JEFException

JEFException(String, Throwable) - Constructor for exception com.norconex.jef4.JEFException

JEFUtil - Class in com.norconex.jef4

jobCompleted(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobLifeCycleListener

jobCompleted(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobStateChangeListener

jobCompleted(IJobStatus) - Method in interface com.norconex.jef4.job.IJobLifeCycleListener

Invoked after a job normally finished its execution.

JobDuration - Class in com.norconex.jef4.status

Holds time-related information about a job execution.

JobDuration() - Constructor for class com.norconex.jef4.status.JobDuration

Creates a job elapsed time.

jobError(JobErrorEvent) - Method in interface com.norconex.jef4.job.IJobErrorListener

Receives notification of a job error.

jobError(JobErrorEvent) - Method in class com.norconex.jef4.mail.ErrorMailNotifier

JobErrorEvent - Class in com.norconex.jef4.job

Event thrown by the framework to all registered ErrorHandler instances.

JobErrorEvent(Throwable, JobSuite, IJobStatus) - Constructor for class com.norconex.jef4.job.JobErrorEvent

JobException - Exception in com.norconex.jef4.job

Represents a job-related exception.

JobException(String) - Constructor for exception com.norconex.jef4.job.JobException

JobException(Throwable) - Constructor for exception com.norconex.jef4.job.JobException

JobException(String, Throwable) - Constructor for exception com.norconex.jef4.job.JobException

JobHeartbeatGenerator - Class in com.norconex.jef4.suite

JobHeartbeatGenerator(JobSuite) - Constructor for class com.norconex.jef4.suite.JobHeartbeatGenerator

jobProgressed(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobLifeCycleListener

jobProgressed(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobStateChangeListener

jobProgressed(IJobStatus) - Method in interface com.norconex.jef4.job.IJobLifeCycleListener

Invoked every time the status state changes.

jobResumed(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobLifeCycleListener

jobResumed(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobStateChangeListener

jobResumed(IJobStatus) - Method in interface com.norconex.jef4.job.IJobLifeCycleListener

Invoked just before a job resumes its execution.

jobSkipped(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobLifeCycleListener

jobSkipped(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobStateChangeListener

jobSkipped(IJobStatus) - Method in interface com.norconex.jef4.job.IJobLifeCycleListener

Invoked when the execution of a job gets skipped.

jobStarted(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobLifeCycleListener

jobStarted(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobStateChangeListener

jobStarted(IJobStatus) - Method in interface com.norconex.jef4.job.IJobLifeCycleListener

Invoked just before a job begins its execution.

JobState - Enum in com.norconex.jef4.status

jobStateChanged(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobStateChangeListener

Invoked when any of the following are invoked (unless they are overridden): jobTerminatedPrematuraly, jobProgressed, jobStarted, jobResumed, jobStopping, jobStopped, jobCompleted.

JobStatusTreeNode(IJobStatus, IJobStatus, List<JobSuiteStatusSnapshot.JobStatusTreeNode>) - Constructor for class com.norconex.jef4.status.JobSuiteStatusSnapshot.JobStatusTreeNode

JobStatusUpdater - Class in com.norconex.jef4.status

JobStatusUpdater(MutableJobStatus) - Constructor for class com.norconex.jef4.status.JobStatusUpdater

jobStopped(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobLifeCycleListener

jobStopped(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobStateChangeListener

jobStopped(IJobStatus) - Method in interface com.norconex.jef4.job.IJobLifeCycleListener

Invoked just after has stopped.

jobStopping(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobLifeCycleListener

jobStopping(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobStateChangeListener

jobStopping(IJobStatus) - Method in interface com.norconex.jef4.job.IJobLifeCycleListener

Invoked just before a job starts to stop.

JobSuite - Class in com.norconex.jef4.suite

A job suite is an amalgamation of jobs, represented as a single executable unit.

JobSuite(IJob) - Constructor for class com.norconex.jef4.suite.JobSuite

JobSuite(IJob, JobSuiteConfig) - Constructor for class com.norconex.jef4.suite.JobSuite

JobSuiteConfig - Class in com.norconex.jef4.suite

JobSuiteConfig() - Constructor for class com.norconex.jef4.suite.JobSuiteConfig

JobSuiteStatusSnapshot - Class in com.norconex.jef4.status

JobSuiteStatusSnapshot.JobStatusTreeNode - Class in com.norconex.jef4.status

jobTerminatedPrematuraly(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobLifeCycleListener

jobTerminatedPrematuraly(IJobStatus) - Method in class com.norconex.jef4.job.AbstractJobStateChangeListener

jobTerminatedPrematuraly(IJobStatus) - Method in interface com.norconex.jef4.job.IJobLifeCycleListener

Invoked after a job finished its execution before status was 100% complete.

L

loadFromXML(Reader) - Method in class com.norconex.jef4.log.FileLogManager

loadFromXML(Reader) - Method in class com.norconex.jef4.log.NoLogManager

loadFromXML(Reader) - Method in class com.norconex.jef4.status.FileJobStatusStore

M

MutableJobStatus - Class in com.norconex.jef4.status

MutableJobStatus(String) - Constructor for class com.norconex.jef4.status.MutableJobStatus

N

newSnapshot(File) - Static method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

NoLogManager - Class in com.norconex.jef4.log

Use this log manager if you do not want JEF to manage logs.

NoLogManager() - Constructor for class com.norconex.jef4.log.NoLogManager

R

read(String, String) - Method in class com.norconex.jef4.status.FileJobStatusStore

read(String, String) - Method in interface com.norconex.jef4.status.IJobStatusStore

Reads a job progress.

register(MutableJobStatus) - Method in class com.norconex.jef4.suite.JobHeartbeatGenerator

remove(String, String) - Method in class com.norconex.jef4.status.FileJobStatusStore

remove(String, String) - Method in interface com.norconex.jef4.status.IJobStatusStore

Removes job progress.

removeErrorListener(IStreamListener) - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Removes an error (STDERR) listener.

removeOutputListener(IStreamListener) - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Removes an output (STDOUT) listener.

resumeExecution(JobStatusUpdater, JobSuite) - Method in class com.norconex.jef4.job.AbstractResumableJob

Resumes the execution of a job.

RetriableException - Exception in com.norconex.jef4.exec

Deprecated.

Since 4.1.0, this class can be found in Norconex Commons Lang

RetriableException(String) - Constructor for exception com.norconex.jef4.exec.RetriableException

Deprecated.

RetriableException(Throwable) - Constructor for exception com.norconex.jef4.exec.RetriableException

Deprecated.

RetriableException(String, Throwable) - Constructor for exception com.norconex.jef4.exec.RetriableException

Deprecated.

RetriableExecutor - Class in com.norconex.jef4.exec

Deprecated.

Since 4.1.0, this class is now Retrier in Norconex Commons Lang.

RetriableExecutor() - Constructor for class com.norconex.jef4.exec.RetriableExecutor

Deprecated.

Creates a new instance of RetriableExecutor using the default maximum re-run attempts and default re-run wait time.

RetriableExecutor(int) - Constructor for class com.norconex.jef4.exec.RetriableExecutor

Deprecated.

Creates a new instance of RetriableExecutor using the default re-run wait time.

RetriableExecutor(int, long) - Constructor for class com.norconex.jef4.exec.RetriableExecutor

Deprecated.

Creates a new instance of RetriableExecutor.

RetriableExecutor(IExceptionFilter) - Constructor for class com.norconex.jef4.exec.RetriableExecutor

Deprecated.

Creates a new instance of RetriableExecutor which will re-run code triggering exceptions only if the given exception is accepted by the IExceptionFilter.

RetriableExecutor(IExceptionFilter, int) - Constructor for class com.norconex.jef4.exec.RetriableExecutor

Deprecated.

Creates a new instance of RetriableExecutor which will re-run code triggering exceptions only if the given exception is accepted by the IExceptionFilter.

RetriableExecutor(IExceptionFilter, int, long) - Constructor for class com.norconex.jef4.exec.RetriableExecutor

Deprecated.

/** Creates a new instance of RetriableExecutor which will re-run code triggering exceptions only if the given exception is accepted by the IExceptionFilter.

run() - Method in interface com.norconex.jef4.exec.IRetriable

Deprecated.

Code to be executed until successful (no exception thrown).

run() - Method in class com.norconex.jef4.suite.JobHeartbeatGenerator

run() - Method in class com.norconex.jef4.suite.StopRequestMonitor

runJob(IJob) - Method in class com.norconex.jef4.suite.JobSuite

S

saveToXML(Writer) - Method in class com.norconex.jef4.log.FileLogManager

saveToXML(Writer) - Method in class com.norconex.jef4.log.NoLogManager

saveToXML(Writer) - Method in class com.norconex.jef4.status.FileJobStatusStore

send(String, String) - Method in class com.norconex.jef4.mail.SimpleMailer

Sends an email.

send(String, String, String) - Method in class com.norconex.jef4.mail.SimpleMailer

Sends an email.

send(String[], String, String) - Method in class com.norconex.jef4.mail.SimpleMailer

Sends an email.

setCurrentJobId(String) - Static method in class com.norconex.jef4.suite.JobSuite

Sets a job identifier as the currently running job for the the current thread.

setDescription(String) - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Sets the description for this command.

setDuration(JobDuration) - Method in class com.norconex.jef4.status.MutableJobStatus

setEndTime(Date) - Method in class com.norconex.jef4.status.JobDuration

Sets the end time.

setJobErrorListeners(IJobErrorListener...) - Method in class com.norconex.jef4.suite.JobSuiteConfig

setJobLifeCycleListeners(IJobLifeCycleListener...) - Method in class com.norconex.jef4.suite.JobSuiteConfig

setJobStatusStore(IJobStatusStore) - Method in class com.norconex.jef4.suite.JobSuiteConfig

setLastActivity(Date) - Method in class com.norconex.jef4.status.MutableJobStatus

Sets the last activity.

setLogDirectory(String) - Method in class com.norconex.jef4.log.FileLogManager

setLogManager(ILogManager) - Method in class com.norconex.jef4.suite.JobSuiteConfig

setNote(String) - Method in class com.norconex.jef4.status.JobStatusUpdater

setNote(String) - Method in class com.norconex.jef4.status.MutableJobStatus

setProgress(double) - Method in class com.norconex.jef4.status.JobStatusUpdater

setProgress(double) - Method in class com.norconex.jef4.status.MutableJobStatus

setResumeAttempts(int) - Method in class com.norconex.jef4.status.MutableJobStatus

setResumedLastActivity(Date) - Method in class com.norconex.jef4.status.JobDuration

setResumedStartTime(Date) - Method in class com.norconex.jef4.status.JobDuration

setStartTime(Date) - Method in class com.norconex.jef4.status.JobDuration

Sets the start time.

setStatusDirectory(String) - Method in class com.norconex.jef4.status.FileJobStatusStore

setStopRequested(boolean) - Method in class com.norconex.jef4.status.MutableJobStatus

setSuiteLifeCycleListeners(ISuiteLifeCycleListener...) - Method in class com.norconex.jef4.suite.JobSuiteConfig

setWorkdir(String) - Method in class com.norconex.jef4.suite.JobSuiteConfig

SimpleMailer - Class in com.norconex.jef4.mail

Convenience class for sending simple emails.

SimpleMailer(String, String) - Constructor for class com.norconex.jef4.mail.SimpleMailer

Constructor.

SimpleMailer(String, String, String[]) - Constructor for class com.norconex.jef4.mail.SimpleMailer

Constructor.

SimpleMailer(String, String, String) - Constructor for class com.norconex.jef4.mail.SimpleMailer

Constructor.

SimpleMailer(String, String, String[], String) - Constructor for class com.norconex.jef4.mail.SimpleMailer

Constructor.

start() - Method in class com.norconex.jef4.suite.JobHeartbeatGenerator

startExecution(JobStatusUpdater, JobSuite) - Method in class com.norconex.jef4.job.AbstractResumableJob

Starts the execution of a job.

statusUpdated(MutableJobStatus) - Method in class com.norconex.jef4.status.JobStatusUpdater

STDERR - Static variable in class com.norconex.jef4.exec.ExecUtils

Deprecated.

Identifier for standard error.

STDOUT - Static variable in class com.norconex.jef4.exec.ExecUtils

Deprecated.

Identifier for standard output.

stop(IJobStatus, JobSuite) - Method in class com.norconex.jef4.exec.SystemCommandJob

Default implementation of this method will check if the SystemCommand it runs is currently holding to a Process process instance and destroys them.

stop(IJobStatus, JobSuite) - Method in class com.norconex.jef4.job.group.AbstractJobGroup

stop(IJobStatus, JobSuite) - Method in interface com.norconex.jef4.job.IJob

Stops this job.

stop() - Method in class com.norconex.jef4.suite.JobSuite

stop(File) - Static method in class com.norconex.jef4.suite.JobSuite

stopMonitoring() - Method in class com.norconex.jef4.suite.StopRequestMonitor

StopRequestMonitor - Class in com.norconex.jef4.suite

Listens for STOP requests using a stop file.

StopRequestMonitor(JobSuite) - Constructor for class com.norconex.jef4.suite.StopRequestMonitor

suiteAborted(JobSuite) - Method in class com.norconex.jef4.mail.SuiteCompletedMailNotifier

suiteAborted(JobSuite) - Method in class com.norconex.jef4.suite.AbstractSuiteLifeCycleListener

suiteAborted(JobSuite) - Method in interface com.norconex.jef4.suite.ISuiteLifeCycleListener

Invoked when a job suite is aborted.

suiteCompleted(JobSuite) - Method in class com.norconex.jef4.mail.SuiteCompletedMailNotifier

suiteCompleted(JobSuite) - Method in class com.norconex.jef4.suite.AbstractSuiteLifeCycleListener

suiteCompleted(JobSuite) - Method in interface com.norconex.jef4.suite.ISuiteLifeCycleListener

Invoked when a job suite completes.

SuiteCompletedMailNotifier - Class in com.norconex.jef4.mail

Simple suite life-cycle listener notifying email recipients when a job suite completes.

SuiteCompletedMailNotifier(String, String, String) - Constructor for class com.norconex.jef4.mail.SuiteCompletedMailNotifier

SuiteCompletedMailNotifier(String, String, String[]) - Constructor for class com.norconex.jef4.mail.SuiteCompletedMailNotifier

suiteStarted(JobSuite) - Method in class com.norconex.jef4.mail.SuiteCompletedMailNotifier

suiteStarted(JobSuite) - Method in class com.norconex.jef4.suite.AbstractSuiteLifeCycleListener

suiteStarted(JobSuite) - Method in interface com.norconex.jef4.suite.ISuiteLifeCycleListener

Invoked when a job suite is started.

suiteStopped(JobSuite) - Method in class com.norconex.jef4.mail.SuiteCompletedMailNotifier

suiteStopped(JobSuite) - Method in class com.norconex.jef4.suite.AbstractSuiteLifeCycleListener

suiteStopped(JobSuite) - Method in interface com.norconex.jef4.suite.ISuiteLifeCycleListener

Invoked when a job suite is stopped.

suiteStopping(JobSuite) - Method in class com.norconex.jef4.mail.SuiteCompletedMailNotifier

suiteStopping(JobSuite) - Method in class com.norconex.jef4.suite.AbstractSuiteLifeCycleListener

suiteStopping(JobSuite) - Method in interface com.norconex.jef4.suite.ISuiteLifeCycleListener

Invoked when a job suite is stopping.

suiteTerminatedPrematuraly(JobSuite) - Method in class com.norconex.jef4.mail.SuiteCompletedMailNotifier

suiteTerminatedPrematuraly(JobSuite) - Method in class com.norconex.jef4.suite.AbstractSuiteLifeCycleListener

suiteTerminatedPrematuraly(JobSuite) - Method in interface com.norconex.jef4.suite.ISuiteLifeCycleListener

Invoked when a job suite finished executing.

SyncJobGroup - Class in com.norconex.jef4.job.group

Job responsible for running a group of jobs synchronously.

SyncJobGroup(String, IJob...) - Constructor for class com.norconex.jef4.job.group.SyncJobGroup

SystemCommand - Class in com.norconex.jef4.exec

Deprecated.

Since 4.1.0, this class can be found in Norconex Commons Lang

SystemCommand(String...) - Constructor for class com.norconex.jef4.exec.SystemCommand

Deprecated.

Creates a command for which the execution will be in the working directory of the current process.

SystemCommand(File, String...) - Constructor for class com.norconex.jef4.exec.SystemCommand

Deprecated.

Creates a command.

SystemCommandJob - Class in com.norconex.jef4.exec

JEF job for executing an arbitrary number of commands.

SystemCommandJob(String, String...) - Constructor for class com.norconex.jef4.exec.SystemCommandJob

Creates a JEF job for executing system commands.

SystemCommandJob(String, SystemCommand...) - Constructor for class com.norconex.jef4.exec.SystemCommandJob

Creates a JEF job for executing system commands.

T

terminate() - Method in class com.norconex.jef4.suite.JobHeartbeatGenerator

ThreadSafeLayout - Class in com.norconex.jef4.log

Log layout decorator, prefixing any existing layout with the job id associated with the current thread, separated with colon-space (": ").

ThreadSafeLayout(Layout) - Constructor for class com.norconex.jef4.log.ThreadSafeLayout

Constructor.

toString() - Method in class com.norconex.jef4.exec.SystemCommand

Deprecated.

Returns the command to be executed.

toString() - Method in class com.norconex.jef4.log.FileLogManager

toString() - Method in class com.norconex.jef4.log.NoLogManager

toString() - Method in class com.norconex.jef4.status.FileJobStatusStore

toString() - Method in class com.norconex.jef4.status.JobDuration

toString() - Method in class com.norconex.jef4.status.JobSuiteStatusSnapshot

toString() - Method in class com.norconex.jef4.status.MutableJobStatus

touch(String, String) - Method in class com.norconex.jef4.status.FileJobStatusStore

touch(String, String) - Method in interface com.norconex.jef4.status.IJobStatusStore

Marks the status with the current date so it shows as being active.

U

unregister(MutableJobStatus) - Method in class com.norconex.jef4.suite.JobHeartbeatGenerator

V

valueOf(String) - Static method in enum com.norconex.jef4.status.JobState

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.norconex.jef4.status.JobState

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

visitJob(IJob, IJobStatus) - Method in interface com.norconex.jef4.job.IJobVisitor

Visits a job.

visitJobStatus(IJobStatus) - Method in interface com.norconex.jef4.status.IJobStatusVisitor

Visits a job status.

W

watchProcess(Process) - Static method in class com.norconex.jef4.exec.ExecUtils

Deprecated.

Watches a running process.

watchProcess(Process, IStreamListener) - Static method in class com.norconex.jef4.exec.ExecUtils

Deprecated.

Watches a running process.

watchProcess(Process, IStreamListener[]) - Static method in class com.norconex.jef4.exec.ExecUtils

Deprecated.

Watches a running process.

watchProcess(Process, IStreamListener, IStreamListener) - Static method in class com.norconex.jef4.exec.ExecUtils

Deprecated.

Watches a running process.

watchProcess(Process, IStreamListener[], IStreamListener[]) - Static method in class com.norconex.jef4.exec.ExecUtils

Deprecated.

Watches a running process.

watchProcessOutput(Process, IStreamListener, IStreamListener) - Static method in class com.norconex.jef4.exec.ExecUtils

Deprecated.

Watches process output.

watchProcessOutput(Process, IStreamListener[], IStreamListener[]) - Static method in class com.norconex.jef4.exec.ExecUtils

Deprecated.

Watches process output.

write(String, IJobStatus) - Method in class com.norconex.jef4.status.FileJobStatusStore

write(String, IJobStatus) - Method in interface com.norconex.jef4.status.IJobStatusStore

Writes a job progress.

A B C D E F G H I J L M N R S T U V W