A B C D E F G H I J P R S T U V W X

A

abort() - Method in class com.norconex.jef.exec.SystemCommand
Aborts the running command.
AbstractJob - Class in com.norconex.jef
Convenient base class for implementing jobs.
AbstractJob(String) - Constructor for class com.norconex.jef.AbstractJob
Creates a new job.
AbstractJobGroup - Class in com.norconex.jef
Base implementation for job groups.
AbstractJobGroup(String, IJob...) - Constructor for class com.norconex.jef.AbstractJobGroup
Constructor.
AbstractJobGroup(String, String, IJob...) - Constructor for class com.norconex.jef.AbstractJobGroup
Constructor.
AbstractJobSuiteVisitor - Class in com.norconex.jef.suite
Convenience base implementation of IJobSuiteVisitor.
AbstractJobSuiteVisitor() - Constructor for class com.norconex.jef.suite.AbstractJobSuiteVisitor
 
AbstractMailNotifier - Class in com.norconex.jef.mail
Convenience base class for sending email notifications.
AbstractMailNotifier(String, String, String) - Constructor for class com.norconex.jef.mail.AbstractMailNotifier
Constructor.
AbstractMailNotifier(String, String, String[]) - Constructor for class com.norconex.jef.mail.AbstractMailNotifier
Constructor.
AbstractResumableJob - Class in com.norconex.jef
Convenience class separating normal execution from recovery.
AbstractResumableJob() - Constructor for class com.norconex.jef.AbstractResumableJob
Constructor.
accept(Exception) - Method in interface com.norconex.jef.exec.IExceptionFilter
Filters an exception.
accept(IJobSuiteVisitor) - Method in class com.norconex.jef.suite.JobSuite
Accepts a job suite visitor.
accept(IJobSuiteVisitor, Class<IJob>) - Method in class com.norconex.jef.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.jef.log.ThreadSafeLayout
 
ACTIVITY_CHECK - Static variable in class com.norconex.jef.progress.JobProgress
Frequency of activity check.
addErrorHandler(IErrorHandler) - Method in class com.norconex.jef.suite.JobSuite
Adds an error handler.
addErrorListener(IStreamListener) - Method in class com.norconex.jef.exec.SystemCommand
Adds an error (STDERR) listener to this system command.
addJobProgressListener(IJobProgressListener) - Method in class com.norconex.jef.progress.JobProgress
Adds a job progress listener.
addJobProgressListener(IJobProgressListener) - Method in class com.norconex.jef.suite.JobSuite
Adds a job progress listener.
addOutputListener(IStreamListener) - Method in class com.norconex.jef.exec.SystemCommand
Adds an output (STDOUT) listener to this system command.
addSuiteLifeCycleListener(ISuiteLifeCycleListener) - Method in class com.norconex.jef.suite.JobSuite
Adds a suite life cycle listener.
addSuiteStopRequestListener(ISuiteStopRequestListener) - Method in class com.norconex.jef.suite.JobSuite
Adds a job progress listener.
AsyncJobGroup - Class in com.norconex.jef
Job responsible for running a group of jobs asynchronously.
AsyncJobGroup(String, IJob...) - Constructor for class com.norconex.jef.AsyncJobGroup
Constructor.
AsyncJobGroup(String, String, IJob...) - Constructor for class com.norconex.jef.AsyncJobGroup
Constructor.
AsyncLimitedJobGroup - Class in com.norconex.jef
Job responsible for running a group of jobs asynchronously with only so many jobs running at the same time.
AsyncLimitedJobGroup(String, int, IJob...) - Constructor for class com.norconex.jef.AsyncLimitedJobGroup
Constructor.
AsyncLimitedJobGroup(String, int, String, IJob...) - Constructor for class com.norconex.jef.AsyncLimitedJobGroup
Constructor.

B

backup(String, Date) - Method in class com.norconex.jef.log.FileLogManager
 
backup(String, Date) - Method in interface com.norconex.jef.log.ILogManager
Backups the log for the given name space, and time stamps it with the given date.
backup(String, String, Date) - Method in interface com.norconex.jef.progress.IJobProgressSerializer
Backups job progress.
backup(String, String, Date) - Method in class com.norconex.jef.progress.JobProgressPropertiesFileSerializer
 

C

com.norconex.jef - package com.norconex.jef
Core classes making up the Job Execution Framework.
com.norconex.jef.error - package com.norconex.jef.error
Classes related to error/exception handling.
com.norconex.jef.exec - package com.norconex.jef.exec
Utility classes related to process/code execution.
com.norconex.jef.log - package com.norconex.jef.log
Classes related to logging.
com.norconex.jef.mail - package com.norconex.jef.mail
Optional package containing convenient classes for sendind simple email notifications.
com.norconex.jef.progress - package com.norconex.jef.progress
Classes used to record and keep track of execution progess.
com.norconex.jef.progress.snapshot - package com.norconex.jef.progress.snapshot
Classes related to capturing job progress at a moment in time.
com.norconex.jef.suite - package com.norconex.jef.suite
Classes related to job suites.
createAppender(String) - Method in class com.norconex.jef.log.FileLogManager
 
createAppender(String) - Method in interface com.norconex.jef.log.ILogManager
Creates a Log4J appender for the given name space.
createJobContext() - Method in class com.norconex.jef.AbstractJobGroup
 
createJobContext() - Method in class com.norconex.jef.exec.SystemCommandJob
 
createJobContext() - Method in interface com.norconex.jef.IJob
Contextual information about the job to run.
createJobSuite() - Method in interface com.norconex.jef.suite.IJobSuiteFactory
Creates a job suite.

D

DEFAULT_MAX_RERUN_ATTEMPTS - Static variable in class com.norconex.jef.exec.Rerunner
Default maximum number of retries.
DEFAULT_RERUN_SLEEP_TIME - Static variable in class com.norconex.jef.exec.Rerunner
Default wait time (milliseconds) between reruns.
deserialize(String, String, IJobContext) - Method in interface com.norconex.jef.progress.IJobProgressSerializer
Deserializes a job progress.
deserialize(String, String, IJobContext) - Method in class com.norconex.jef.progress.JobProgressPropertiesFileSerializer
 

E

ErrorMailNotifier - Class in com.norconex.jef.mail
Simple error handler notifying email recipients when exceptions occur.
ErrorMailNotifier(String, String, String) - Constructor for class com.norconex.jef.mail.ErrorMailNotifier
 
ErrorMailNotifier(String, String, String[]) - Constructor for class com.norconex.jef.mail.ErrorMailNotifier
 
execute(JobProgress, JobSuite) - Method in class com.norconex.jef.AbstractResumableJob
 
execute(JobProgress, JobSuite) - Method in class com.norconex.jef.AsyncJobGroup
 
execute(JobProgress, JobSuite) - Method in class com.norconex.jef.AsyncLimitedJobGroup
 
execute() - Method in class com.norconex.jef.exec.SystemCommand
Executes the given command and returns only when the underlying process stopped running.
execute(boolean) - Method in class com.norconex.jef.exec.SystemCommand
Executes the given system command.
execute(JobProgress, JobSuite) - Method in class com.norconex.jef.exec.SystemCommandJob
 
execute(JobProgress, JobSuite) - Method in interface com.norconex.jef.IJob
Executes this job.
execute(JobProgress, JobSuite) - Method in class com.norconex.jef.SyncJobGroup
 
ExecUtils - Class in com.norconex.jef.exec
Utility methods related to process execution.

F

FileLogManager - Class in com.norconex.jef.log
Log manager using the file system to store its logs.
FileLogManager(String) - Constructor for class com.norconex.jef.log.FileLogManager
Constructor.
FileLogManager(String, Layout) - Constructor for class com.norconex.jef.log.FileLogManager
Creates a new FileLogManager, wrapping the given layout into a ThreadSafeLayout.
FileStopRequestHandler - Class in com.norconex.jef.suite
Listens for STOP requests using a stop file.
FileStopRequestHandler(String, String) - Constructor for class com.norconex.jef.suite.FileStopRequestHandler
Creates a file-based job stop request advisor storing files in the given job directory.
fireProgressChanged() - Method in class com.norconex.jef.progress.JobProgress
Notifies all listeners of a change of progress.
fireStopRequest() - Method in class com.norconex.jef.suite.FileStopRequestHandler
Fires a stop request.
format(LoggingEvent) - Method in class com.norconex.jef.log.ThreadSafeLayout
Calls the decorated instance, prefixing with job identifier.

G

getChildren() - Method in interface com.norconex.jef.progress.snapshot.IProgressSnapshot
Children progress if the job this progress represents has child jobs.
getCommand() - Method in class com.norconex.jef.exec.SystemCommand
Gets the command to be run.
getCompletionRatio() - Method in interface com.norconex.jef.progress.IJobStatus
Gets the job completion ration.
getCompletionRatio() - Method in class com.norconex.jef.progress.JobProgress
Gets the job completion ration.
getCurrentJobId() - Static method in class com.norconex.jef.JobRunner
Gets the job identifier representing the currently running job for the current thread.
getDefaultWorkDir() - Static method in class com.norconex.jef.suite.JobSuite
Gets the default path to the JEF working directory for file-system related operations.
getDescription() - Method in class com.norconex.jef.exec.SystemCommand
Gets the description for this command.
getDescription() - Method in interface com.norconex.jef.IJobContext
Gets the job description.
getDescription() - Method in class com.norconex.jef.JobContext
 
getElapsedTime() - Method in interface com.norconex.jef.progress.IJobStatus
Gets how long it took to finish a job, in milliseconds.
getElapsedTime() - Method in class com.norconex.jef.progress.JobElapsedTime
Gets the elapsed time in milliseconds between the execution start and end time.
getElapsedTime() - Method in class com.norconex.jef.progress.JobProgress
Gets how long it took to finish a job, in milliseconds.
getElapsedTimeAsString() - Method in class com.norconex.jef.progress.JobElapsedTime
Gets the elapsed time as a string, in a human readable format.
getElapsedTimeAsString() - Method in class com.norconex.jef.progress.JobProgress
Gets a string representation of how long it tooks to finish a job.
getEndTime() - Method in interface com.norconex.jef.progress.IJobStatus
Gets the end date of this progress.
getEndTime() - Method in class com.norconex.jef.progress.JobElapsedTime
Gets the end time.
getEndTime() - Method in class com.norconex.jef.progress.JobProgress
Gets the end date of this progress.
getErrorHandlers() - Method in class com.norconex.jef.suite.JobSuite
Gets all error handlers.
getException() - Method in interface com.norconex.jef.error.IErrorEvent
Gets the exception behind this error.
getId() - Method in class com.norconex.jef.AbstractJob
 
getId() - Method in class com.norconex.jef.AbstractJobGroup
 
getId() - Method in class com.norconex.jef.exec.SystemCommandJob
 
getId() - Method in interface com.norconex.jef.IJob
Gets the job unique identifier.
getJob(String) - Method in class com.norconex.jef.suite.JobSuite
Gets the job instance matching the given job identifier.
getJobContext() - Method in interface com.norconex.jef.progress.IJobStatus
Contextual information about the job this status represents.
getJobContext() - Method in class com.norconex.jef.progress.JobProgress
Gets contextual information about a job.
getJobContext(String) - Method in class com.norconex.jef.suite.JobSuite
 
getJobContext(IJob) - Method in class com.norconex.jef.suite.JobSuite
 
getJobId() - Method in interface com.norconex.jef.progress.IJobStatus
The ID of the job this status represents.
getJobId() - Method in class com.norconex.jef.progress.JobProgress
Gets the associated job unique identifier.
getJobIds() - Method in class com.norconex.jef.suite.JobSuite
Gets all job identifiers in order provided by the suite hierarchy.
getJobProgress(IJob) - Method in class com.norconex.jef.suite.JobSuite
Gets the job progress associated with one of the suite's job.
getJobProgress(String) - Method in class com.norconex.jef.suite.JobSuite
Gets the job progress associated with one of the suite's job.
getJobProgressListeners() - Method in class com.norconex.jef.suite.JobSuite
Gets all job progress listeners.
getJobProgressSerializer() - Method in class com.norconex.jef.suite.JobSuite
Gets the job progress serializer.
getJobs() - Method in class com.norconex.jef.AbstractJobGroup
 
getJobs() - Method in interface com.norconex.jef.IJobGroup
Gets all jobs part of this group.
getJobSuite() - Method in interface com.norconex.jef.error.IErrorEvent
Gets the job suite from which this error occurred.
getLastActivity() - Method in interface com.norconex.jef.progress.IJobStatus
Gets the date on which last activity on the job execution occured.
getLastActivity() - Method in class com.norconex.jef.progress.JobElapsedTime
Gets the last activity.
getLastActivity() - Method in class com.norconex.jef.progress.JobProgress
Gets the date on which last activity on the job execution occured.
getLastFailedJobStatus() - Method in class com.norconex.jef.progress.JobProgress
Gets the last previously failed job progress, if any (assuming we are in recovery).
getLog(String) - Method in class com.norconex.jef.log.FileLogManager
 
getLog(String, String) - Method in class com.norconex.jef.log.FileLogManager
 
getLog(String) - Method in interface com.norconex.jef.log.ILogManager
Gets the log for the given namespace.
getLog(String, String) - Method in interface com.norconex.jef.log.ILogManager
Gets the log for the given namespace and job identifier.
getLogFile(String) - Method in class com.norconex.jef.log.FileLogManager
Gets the log file used by this log manager.
getLogManager() - Method in class com.norconex.jef.suite.JobSuite
Gets the Log4J log manager.
getLogTail(JobSuite, int) - Method in class com.norconex.jef.mail.AbstractMailNotifier
Gets the last lines from a suite log.
getMailer() - Method in class com.norconex.jef.mail.AbstractMailNotifier
Gets the mailer for this notifier.
getMetadata() - Method in interface com.norconex.jef.progress.IJobStatus
Gets meta-data associated with this job progress.
getMetadata() - Method in class com.norconex.jef.progress.JobProgress
Gets meta-data associated with this job progress.
getMetaDataProperties(JobProgress) - Static method in class com.norconex.jef.progress.JobProgressUtils
Gets meta data as a Properties instance.
getNamespace() - Method in class com.norconex.jef.suite.JobSuite
Gets the namespace (unique identifier) associated with this suite.
getNote() - Method in interface com.norconex.jef.progress.IJobStatus
Gets the current progress note.
getNote() - Method in class com.norconex.jef.progress.JobProgress
Gets the current progress note.
getProgress() - Method in interface com.norconex.jef.error.IErrorEvent
Gets the job progress of the job from which the error got triggered.
getProgress() - Method in interface com.norconex.jef.progress.IJobStatus
Gets the current progress.
getProgress() - Method in class com.norconex.jef.progress.JobProgress
Gets the current progress.
getProgressMaximum() - Method in interface com.norconex.jef.IJobContext
Gets the maximum execution progress value.
getProgressMaximum() - Method in class com.norconex.jef.JobContext
 
getProgressMinimum() - Method in interface com.norconex.jef.IJobContext
Gets the minimum execution progress value.
getProgressMinimum() - Method in class com.norconex.jef.JobContext
 
getRecipients() - Method in class com.norconex.jef.mail.AbstractMailNotifier
Gets the email recipients for this notifier.
getRootJob() - Method in class com.norconex.jef.suite.JobSuite
Gets the suite root job.
getStackTrace(Throwable) - Method in class com.norconex.jef.mail.ErrorMailNotifier
 
getStartTime() - Method in interface com.norconex.jef.progress.IJobStatus
Gets the end start of this progress.
getStartTime() - Method in class com.norconex.jef.progress.JobElapsedTime
Gets the start time.
getStartTime() - Method in class com.norconex.jef.progress.JobProgress
Gets the end start of this progress.
getStatus() - Method in interface com.norconex.jef.progress.IJobStatus
Gets the current job status.
getStatus() - Method in class com.norconex.jef.progress.JobProgress
Gets the job execution status.
getStopRequestHandler() - Method in class com.norconex.jef.suite.JobSuite
 
getSuiteLifeCycleListeners() - Method in class com.norconex.jef.suite.JobSuite
Gets all suite life cycle listeners.
getSuiteStatus() - Method in class com.norconex.jef.suite.JobSuite
Gets the job suite status.
getSuiteStopRequestListeners() - Method in class com.norconex.jef.suite.JobSuite
Gets all job progress listeners.
getWorkdir() - Method in class com.norconex.jef.exec.SystemCommand
Gets the command working directory.

H

handleError(IErrorEvent) - Method in interface com.norconex.jef.error.IErrorHandler
Handles an error.
handleError(IErrorEvent) - Method in class com.norconex.jef.mail.ErrorMailNotifier
 

I

IErrorEvent - Interface in com.norconex.jef.error
Event thrown by the framework to all registered ErrorHandler instances.
IErrorHandler - Interface in com.norconex.jef.error
Job Execution Framework error handler.
IExceptionFilter - Interface in com.norconex.jef.exec
Responsible for filtering exceptions.
ignoresThrowable() - Method in class com.norconex.jef.log.ThreadSafeLayout
 
IJob - Interface in com.norconex.jef
A job to be executed by the Job Execution Framework.
IJobContext - Interface in com.norconex.jef
Holds contextual information about a job.
IJobGroup - Interface in com.norconex.jef
A job group is itself a job, with the added responsibility of managing the execution of other jobs.
IJobProgressListener - Interface in com.norconex.jef.progress
Listener for job progress events.
IJobProgressSerializer - Interface in com.norconex.jef.progress
Responsible for serializing a job progress.
IJobStatus - Interface in com.norconex.jef.progress
Representation of a job execution status at any given time.
IJobStatus.Status - Enum in com.norconex.jef.progress
A job execution status.
IJobSuiteFactory - Interface in com.norconex.jef.suite
Job suites are an optional concept allowing to further abstract the job creation process.
IJobSuiteStopRequestHandler - Interface in com.norconex.jef.suite
Implementations of this interface will listen for stop signals sent to a running suite.
IJobSuiteVisitor - Interface in com.norconex.jef.suite
Allows one to "visit" a job suite and walk its job hierarchy with minimal effort.
ILogManager - Interface in com.norconex.jef.log
Class responsible for everything that relates to the underlying logging mechanism.
incrementProgress(long) - Method in class com.norconex.jef.progress.JobProgress
Increments the current progress by the given increment value.
IProgressSnapshot - Interface in com.norconex.jef.progress.snapshot
Immutable instance of a job suite progress at a moment in time.
IProgressSnapshotSerializer - Interface in com.norconex.jef.progress.snapshot
Interface meant to favour integration with other systems, such as monitoring systems.
IRerunnable - Interface in com.norconex.jef.exec
Upon failure, code embedded in the run method will get executed over and over again, provided that the executing class supports IRerunnable.
isRecovery() - Method in interface com.norconex.jef.progress.IJobStatus
Whether this progress is from a recovery attempt from a previously failed job.
isRecovery() - Method in class com.norconex.jef.progress.JobProgress
Whether this progress is from a recovery attempt from a previously failed job.
isRunning() - Method in class com.norconex.jef.exec.SystemCommand
Returns whether the command is currently running.
isStatus(IJobStatus.Status...) - Method in class com.norconex.jef.progress.JobProgress
Checks whether the current progress status matches any of the supplied statuses.
isStopRequested() - Method in interface com.norconex.jef.progress.IJobStatus
Whether a request stop this job was received.
isStopRequested() - Method in class com.norconex.jef.progress.JobProgress
 
ISuiteLifeCycleListener - Interface in com.norconex.jef.suite
Listener for life-cycle activities on a job suite.
ISuiteStopRequestListener - Interface in com.norconex.jef.suite
Implementations are waiting to be notified when a IJobSuiteStopRequestHandler received a stop signal.

J

jobCompleted(IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressListener
Invoked after a job normally finished its execution.
jobCompleted(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressAdapter
 
jobCompleted(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressStateChangeAdapter
 
JobContext - Class in com.norconex.jef
Basic POJO implementation of IJobContext.
JobContext() - Constructor for class com.norconex.jef.JobContext
Constructor.
JobContext(String, long, long) - Constructor for class com.norconex.jef.JobContext
Constructor.
JobContext(IJobContext) - Constructor for class com.norconex.jef.JobContext
Constructor.
JobElapsedTime - Class in com.norconex.jef.progress
Holds time-related information about a job execution.
JobElapsedTime() - Constructor for class com.norconex.jef.progress.JobElapsedTime
Creates a job elapsed time.
JobElapsedTime(Date, Date, Date) - Constructor for class com.norconex.jef.progress.JobElapsedTime
Creates a job elapsed time, initialised.
JobException - Exception in com.norconex.jef
Represents a job-related exception.
JobException(String) - Constructor for exception com.norconex.jef.JobException
 
JobException(Throwable) - Constructor for exception com.norconex.jef.JobException
 
JobException(String, Throwable) - Constructor for exception com.norconex.jef.JobException
 
JobProgress - Class in com.norconex.jef.progress
Responsible for keeping track reporting job execution progress.
JobProgress(String, IJobContext, JobElapsedTime) - Constructor for class com.norconex.jef.progress.JobProgress
Constructor.
JobProgress(String, IJobContext, JobElapsedTime, long) - Constructor for class com.norconex.jef.progress.JobProgress
Constructor.
JobProgress(String, IJobContext, IJobStatus, JobElapsedTime) - Constructor for class com.norconex.jef.progress.JobProgress
Creates a job progress initialised with values from a failed job progress we are recovering from.
JobProgressAdapter - Class in com.norconex.jef.progress
Adapter for a job life-cycle.
JobProgressAdapter() - Constructor for class com.norconex.jef.progress.JobProgressAdapter
 
jobProgressed(IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressListener
Invoked every time the progress state changes.
jobProgressed(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressAdapter
 
jobProgressed(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressStateChangeAdapter
 
JobProgressPropertiesFileSerializer - Class in com.norconex.jef.progress
Serializer using a file to store job process information.
JobProgressPropertiesFileSerializer(String) - Constructor for class com.norconex.jef.progress.JobProgressPropertiesFileSerializer
Creates a file-based job progress serializer storing files in the given job directory.
JobProgressStateChangeAdapter - Class in com.norconex.jef.progress
Adapter for a job life-cycle, focusing on progress state changes.
JobProgressStateChangeAdapter() - Constructor for class com.norconex.jef.progress.JobProgressStateChangeAdapter
 
JobProgressUtils - Class in com.norconex.jef.progress
Utility methods for facilitating common job progress operations.
jobResumed(IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressListener
Invoked just before a job resumes its execution.
jobResumed(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressAdapter
 
jobResumed(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressStateChangeAdapter
 
JobRunner - Class in com.norconex.jef
Responsible for managing the execution of a suite and its related jobs.
JobRunner() - Constructor for class com.norconex.jef.JobRunner
 
jobRunningVerified(IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressListener
Invoked at regular intervals to confirm the job is still running.
jobRunningVerified(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressAdapter
 
jobSkipped(IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressListener
Invoked when the execution of a job gets skipped.
jobSkipped(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressAdapter
 
jobStarted(IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressListener
Invoked just before a job begins its execution.
jobStarted(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressAdapter
 
jobStarted(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressStateChangeAdapter
 
jobStateChanged(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressStateChangeAdapter
Invoked when any of the following are invoked (unless they are overridden): jobTerminatedPrematuraly, jobProgressed, jobStarted, jobResumed, jobStopping, jobStopped, jobCompleted.
jobStopped(IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressListener
Invoked just after has stopped.
jobStopped(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressAdapter
 
jobStopped(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressStateChangeAdapter
 
jobStopping(IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressListener
Invoked just before a job starts to stop.
jobStopping(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressAdapter
 
jobStopping(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressStateChangeAdapter
 
JobSuite - Class in com.norconex.jef.suite
A job suite is an amalgamation of jobs, represented as a single executable unit.
JobSuite(IJob) - Constructor for class com.norconex.jef.suite.JobSuite
Creates a new job suite using a FileLogManager and a JobProgressPropertiesFileSerializer.
JobSuite(IJob, IJobProgressSerializer) - Constructor for class com.norconex.jef.suite.JobSuite
Creates a new job suite using a FileLogManager.
JobSuite(IJob, ILogManager) - Constructor for class com.norconex.jef.suite.JobSuite
Creates a new job suite using a JobProgressPropertiesFileSerializer.
JobSuite(IJob, IJobProgressSerializer, ILogManager) - Constructor for class com.norconex.jef.suite.JobSuite
Creates a new job suite.
JobSuite(IJob, IJobProgressSerializer, ILogManager, IJobSuiteStopRequestHandler) - Constructor for class com.norconex.jef.suite.JobSuite
Creates a new job suite.
jobTerminatedPrematuraly(IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressListener
Invoked after a job finished its execution before progress was 100% complete.
jobTerminatedPrematuraly(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressAdapter
 
jobTerminatedPrematuraly(IJobStatus) - Method in class com.norconex.jef.progress.JobProgressStateChangeAdapter
 

P

PROGRESS_100 - Static variable in interface com.norconex.jef.IJobContext
 
PROGRESS_ZERO - Static variable in interface com.norconex.jef.IJobContext
 
ProgressSnapshotTaker - Class in com.norconex.jef.progress.snapshot
 

R

readProgressSnapshot(Reader) - Method in interface com.norconex.jef.progress.snapshot.IProgressSnapshotSerializer
Reads a job progress snapshot.
readProgressSnapshot(Reader) - Method in class com.norconex.jef.progress.snapshot.XMLProgressSnapshotSerializer
 
registerGroupProgressMonitoring(JobProgress, JobSuite) - Method in class com.norconex.jef.AbstractJobGroup
Registers a monitoring process so that individual job progress part of this group gets reflected on the group overall progress.
remove(String, String) - Method in interface com.norconex.jef.progress.IJobProgressSerializer
Removes job progress.
remove(String, String) - Method in class com.norconex.jef.progress.JobProgressPropertiesFileSerializer
 
removeErrorHandler(IErrorHandler) - Method in class com.norconex.jef.suite.JobSuite
Removes an error handler.
removeErrorListener(IStreamListener) - Method in class com.norconex.jef.exec.SystemCommand
Removes an error (STDERR) listener.
removeJobProgressListener(IJobProgressListener) - Method in class com.norconex.jef.progress.JobProgress
Removes a job progress listener.
removeJobProgressListener(IJobProgressListener) - Method in class com.norconex.jef.suite.JobSuite
Removes a job progress listener.
removeOutputListener(IStreamListener) - Method in class com.norconex.jef.exec.SystemCommand
Removes an output (STDOUT) listener.
removeSuiteLifeCycleListener(ISuiteLifeCycleListener) - Method in class com.norconex.jef.suite.JobSuite
Removes a suite life cycle listener.
removeSuiteStopRequestListener(ISuiteStopRequestListener) - Method in class com.norconex.jef.suite.JobSuite
Removes a job progress listener.
RerunnableException - Exception in com.norconex.jef.exec
An exception throws by a executing Rerunner instance when the code executed itself threw an exception, or maximum retry attempts has been reached.
RerunnableException(String) - Constructor for exception com.norconex.jef.exec.RerunnableException
 
RerunnableException(Throwable) - Constructor for exception com.norconex.jef.exec.RerunnableException
 
RerunnableException(String, Throwable) - Constructor for exception com.norconex.jef.exec.RerunnableException
 
Rerunner - Class in com.norconex.jef.exec
Rerunner is responsible for executing IRerunnable instances.
Rerunner() - Constructor for class com.norconex.jef.exec.Rerunner
Creates a new instance of Rerunner using the default maximum re-run attempts and default re-run wait time.
Rerunner(int) - Constructor for class com.norconex.jef.exec.Rerunner
Creates a new instance of Rerunner using the default re-run wait time.
Rerunner(int, long) - Constructor for class com.norconex.jef.exec.Rerunner
Creates a new instance of Rerunner.
Rerunner(IExceptionFilter) - Constructor for class com.norconex.jef.exec.Rerunner
Creates a new instance of Rerunner which will re-run code triggering exceptions only if the given exception is accepted by the IExceptionFilter.
Rerunner(IExceptionFilter, int) - Constructor for class com.norconex.jef.exec.Rerunner
Creates a new instance of Rerunner which will re-run code triggering exceptions only if the given exception is accepted by the IExceptionFilter.
Rerunner(IExceptionFilter, int, long) - Constructor for class com.norconex.jef.exec.Rerunner
/** Creates a new instance of Rerunner which will re-run code triggering exceptions only if the given exception is accepted by the IExceptionFilter.
resumeExecution(JobProgress, JobSuite) - Method in class com.norconex.jef.AbstractResumableJob
Resumes the execution of a job.
run() - Method in interface com.norconex.jef.exec.IRerunnable
Code to be executed until successful (no exception thrown).
run(IRerunnable) - Method in class com.norconex.jef.exec.Rerunner
Runs the IRerunnable instance.
runSuite(JobSuite) - Method in class com.norconex.jef.JobRunner
Runs a job suite.
runSuite(JobSuite, boolean) - Method in class com.norconex.jef.JobRunner
Runs a job suite.

S

send(String, String) - Method in class com.norconex.jef.mail.SimpleMailer
Sends an email.
send(String, String, String) - Method in class com.norconex.jef.mail.SimpleMailer
Sends an email.
send(String[], String, String) - Method in class com.norconex.jef.mail.SimpleMailer
Sends an email.
serialize(String, IJobStatus) - Method in interface com.norconex.jef.progress.IJobProgressSerializer
Serializes a job progress.
serialize(String, IJobStatus) - Method in class com.norconex.jef.progress.JobProgressPropertiesFileSerializer
 
setCurrentJobId(String) - Static method in class com.norconex.jef.JobRunner
Sets a job identifier as the currently running job for the the current thread.
setDescription(String) - Method in class com.norconex.jef.exec.SystemCommand
Sets the description for this command.
setDescription(String) - Method in class com.norconex.jef.JobContext
 
setEndTime(Date) - Method in class com.norconex.jef.progress.JobElapsedTime
Sets the end time.
setLastActivity(Date) - Method in class com.norconex.jef.progress.JobElapsedTime
Sets the last activity.
setMetadata(String) - Method in class com.norconex.jef.progress.JobProgress
Sets meta-data associated with this job progress.
setMetaDataProperties(JobProgress, Properties) - Static method in class com.norconex.jef.progress.JobProgressUtils
Sets meta data as a string from a Properties instance.
setNote(String) - Method in class com.norconex.jef.progress.JobProgress
Sets teh current progress note.
setProgress(long) - Method in class com.norconex.jef.progress.JobProgress
Sets the current progress.
setProgressMaximum(long) - Method in class com.norconex.jef.JobContext
 
setProgressMinimum(long) - Method in class com.norconex.jef.JobContext
 
setStartTime(Date) - Method in class com.norconex.jef.progress.JobElapsedTime
Sets the start time.
SimpleMailer - Class in com.norconex.jef.mail
Convenience class for sending simple emails.
SimpleMailer(String, String) - Constructor for class com.norconex.jef.mail.SimpleMailer
Constructor.
SimpleMailer(String, String, String[]) - Constructor for class com.norconex.jef.mail.SimpleMailer
Constructor.
SimpleMailer(String, String, String) - Constructor for class com.norconex.jef.mail.SimpleMailer
Constructor.
SimpleMailer(String, String, String[], String) - Constructor for class com.norconex.jef.mail.SimpleMailer
Constructor.
startExecution(JobProgress, JobSuite) - Method in class com.norconex.jef.AbstractResumableJob
Starts the execution of a job.
startListening(ISuiteStopRequestListener) - Method in class com.norconex.jef.suite.FileStopRequestHandler
 
startListening(ISuiteStopRequestListener) - Method in interface com.norconex.jef.suite.IJobSuiteStopRequestHandler
Starts to listen for stop requests.
STDERR - Static variable in class com.norconex.jef.exec.ExecUtils
Identifier for standard error.
STDOUT - Static variable in class com.norconex.jef.exec.ExecUtils
Identifier for standard output.
stop(IJobStatus, JobSuite) - Method in class com.norconex.jef.AbstractJobGroup
 
stop(IJobStatus, JobSuite) - Method in class com.norconex.jef.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 interface com.norconex.jef.IJob
Stops this job.
stop() - Method in class com.norconex.jef.suite.JobSuite
Stops this job suite.
stopListening() - Method in class com.norconex.jef.suite.FileStopRequestHandler
 
stopListening() - Method in interface com.norconex.jef.suite.IJobSuiteStopRequestHandler
Stops listening for stop requests.
stopRequestReceived() - Method in class com.norconex.jef.progress.JobProgress
Notifies the job progress that a stop request was received.
stopRequestReceived() - Method in interface com.norconex.jef.suite.ISuiteStopRequestListener
Invoked when a stop signal was received.
suiteAborted(JobSuite) - Method in class com.norconex.jef.mail.SuiteCompletedMailNotifier
 
suiteAborted(JobSuite) - Method in interface com.norconex.jef.suite.ISuiteLifeCycleListener
Invoked when a job suite is aborted.
suiteAborted(JobSuite) - Method in class com.norconex.jef.suite.SuiteLifeCycleAdapter
 
suiteCompleted(JobSuite) - Method in class com.norconex.jef.mail.SuiteCompletedMailNotifier
 
suiteCompleted(JobSuite) - Method in interface com.norconex.jef.suite.ISuiteLifeCycleListener
Invoked when a job suite completes.
suiteCompleted(JobSuite) - Method in class com.norconex.jef.suite.SuiteLifeCycleAdapter
 
SuiteCompletedMailNotifier - Class in com.norconex.jef.mail
Simple suite life-cycle listener notifying email recipients when a job suite completes.
SuiteCompletedMailNotifier(String, String, String) - Constructor for class com.norconex.jef.mail.SuiteCompletedMailNotifier
 
SuiteCompletedMailNotifier(String, String, String[]) - Constructor for class com.norconex.jef.mail.SuiteCompletedMailNotifier
 
SuiteLifeCycleAdapter - Class in com.norconex.jef.suite
Adapter for a suite life-cycle listener.
SuiteLifeCycleAdapter() - Constructor for class com.norconex.jef.suite.SuiteLifeCycleAdapter
 
suiteStarted(JobSuite) - Method in class com.norconex.jef.mail.SuiteCompletedMailNotifier
 
suiteStarted(JobSuite) - Method in interface com.norconex.jef.suite.ISuiteLifeCycleListener
Invoked when a job suite is started.
suiteStarted(JobSuite) - Method in class com.norconex.jef.suite.SuiteLifeCycleAdapter
 
suiteStopped(JobSuite) - Method in class com.norconex.jef.mail.SuiteCompletedMailNotifier
 
suiteStopped(JobSuite) - Method in interface com.norconex.jef.suite.ISuiteLifeCycleListener
Invoked when a job suite is stopped.
suiteStopped(JobSuite) - Method in class com.norconex.jef.suite.SuiteLifeCycleAdapter
 
suiteStopping(JobSuite) - Method in class com.norconex.jef.mail.SuiteCompletedMailNotifier
 
suiteStopping(JobSuite) - Method in interface com.norconex.jef.suite.ISuiteLifeCycleListener
Invoked when a job suite is stopping.
suiteStopping(JobSuite) - Method in class com.norconex.jef.suite.SuiteLifeCycleAdapter
 
suiteTerminatedPrematuraly(JobSuite) - Method in class com.norconex.jef.mail.SuiteCompletedMailNotifier
 
suiteTerminatedPrematuraly(JobSuite) - Method in interface com.norconex.jef.suite.ISuiteLifeCycleListener
Invoked when a job suite finished executing.
suiteTerminatedPrematuraly(JobSuite) - Method in class com.norconex.jef.suite.SuiteLifeCycleAdapter
 
SyncJobGroup - Class in com.norconex.jef
Job responsible for running a group of jobs synchronously.
SyncJobGroup(String, IJob...) - Constructor for class com.norconex.jef.SyncJobGroup
 
SyncJobGroup(String, String, IJob...) - Constructor for class com.norconex.jef.SyncJobGroup
 
SystemCommand - Class in com.norconex.jef.exec
Represents a program to be executed by the underlying system (on the "command line").
SystemCommand(String...) - Constructor for class com.norconex.jef.exec.SystemCommand
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.jef.exec.SystemCommand
Creates a command.
SystemCommandJob - Class in com.norconex.jef.exec
JEF job for executing an arbitrary number of commands.
SystemCommandJob(String, String, String[]) - Constructor for class com.norconex.jef.exec.SystemCommandJob
Creates a JEF job for executing system commands.
SystemCommandJob(String, String, String) - Constructor for class com.norconex.jef.exec.SystemCommandJob
Creates a JEF job for executing a system command.
SystemCommandJob(String, String, SystemCommand[]) - Constructor for class com.norconex.jef.exec.SystemCommandJob
Creates a JEF job for executing system commands.
SystemCommandJob(String, String, SystemCommand) - Constructor for class com.norconex.jef.exec.SystemCommandJob
Creates a JEF job for executing a system command.

T

takeSnapshot(JobSuite) - Static method in class com.norconex.jef.progress.snapshot.ProgressSnapshotTaker
 
ThreadSafeLayout - Class in com.norconex.jef.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.jef.log.ThreadSafeLayout
Constructor.
toString() - Method in class com.norconex.jef.exec.SystemCommand
Returns the command to be executed.
toString() - Method in class com.norconex.jef.JobContext
 
toString() - Method in class com.norconex.jef.progress.JobProgress
 

U

unregisterGroupProgressMonitoring(JobSuite) - Method in class com.norconex.jef.AbstractJobGroup
Unregisters the monitoring process associated with the given job suite.

V

valueOf(String) - Static method in enum com.norconex.jef.progress.IJobStatus.Status
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.norconex.jef.progress.IJobStatus.Status
Returns an array containing the constants of this enum type, in the order they are declared.
visitJob(IJob) - Method in class com.norconex.jef.suite.AbstractJobSuiteVisitor
 
visitJob(IJob) - Method in interface com.norconex.jef.suite.IJobSuiteVisitor
Visits a job.
visitJobProgress(IJobStatus) - Method in class com.norconex.jef.suite.AbstractJobSuiteVisitor
 
visitJobProgress(IJobStatus) - Method in interface com.norconex.jef.suite.IJobSuiteVisitor
Visits a job progress.
visitJobSuite(JobSuite) - Method in class com.norconex.jef.suite.AbstractJobSuiteVisitor
 
visitJobSuite(JobSuite) - Method in interface com.norconex.jef.suite.IJobSuiteVisitor
Visits a job suite.

W

watchProcess(Process) - Static method in class com.norconex.jef.exec.ExecUtils
Watches a running process.
watchProcess(Process, IStreamListener) - Static method in class com.norconex.jef.exec.ExecUtils
Watches a running process.
watchProcess(Process, IStreamListener[]) - Static method in class com.norconex.jef.exec.ExecUtils
Watches a running process.
watchProcess(Process, IStreamListener, IStreamListener) - Static method in class com.norconex.jef.exec.ExecUtils
Watches a running process.
watchProcess(Process, IStreamListener[], IStreamListener[]) - Static method in class com.norconex.jef.exec.ExecUtils
Watches a running process.
watchProcessOutput(Process, IStreamListener, IStreamListener) - Static method in class com.norconex.jef.exec.ExecUtils
Watches process output.
watchProcessOutput(Process, IStreamListener[], IStreamListener[]) - Static method in class com.norconex.jef.exec.ExecUtils
Watches process output.
writeProgressSnapshot(Writer, IProgressSnapshot) - Method in interface com.norconex.jef.progress.snapshot.IProgressSnapshotSerializer
Writes a job progress snapshot.
writeProgressSnapshot(Writer, IProgressSnapshot) - Method in class com.norconex.jef.progress.snapshot.XMLProgressSnapshotSerializer
 

X

XMLProgressSnapshotSerializer - Class in com.norconex.jef.progress.snapshot
Renders the a job suite progress snapshot in XML format.
XMLProgressSnapshotSerializer() - Constructor for class com.norconex.jef.progress.snapshot.XMLProgressSnapshotSerializer
 

A B C D E F G H I J P R S T U V W X

Copyright © 2007-2013 Norconex Inc.. All Rights Reserved.