org.apache.sling.bgservlets

Interface JobConsole

public interface JobConsole

Back-end for management consoles that give access to background jobs.

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<JobStatus>	getJobStatus(Session session, boolean activeOnly) Return Iterator on JobStatus, in descending order of creation date.
JobStatus	getJobStatus(Session session, java.lang.String path) Return a single JobStatus, null if not found.
java.lang.String	getJobStatusPagePath(javax.servlet.http.HttpServletRequest request, JobStatus jobStatus, java.lang.String extension) Return the full path, including extension, to the job's status page.
java.lang.String	getJobStreamPath(javax.servlet.http.HttpServletRequest request, JobStatus jobStatus) Return the full path, including extension, to the job's stream

Method Detail

getJobStatus

java.util.Iterator<JobStatus> getJobStatus(Session session,
                                           boolean activeOnly)

Return Iterator on JobStatus, in descending order of creation date.

Parameters:

session - not used if activeOnly = true

activeOnly - if true, only jobs that are currently active in the ExecutionEngine are returned.

getJobStatus

JobStatus getJobStatus(Session session,
                       java.lang.String path)

Return a single JobStatus, null if not found.

Parameters:

session - Session to use if reading from persistent storage

path - the job path

getJobStatusPagePath

java.lang.String getJobStatusPagePath(javax.servlet.http.HttpServletRequest request,
                                      JobStatus jobStatus,
                                      java.lang.String extension)

Return the full path, including extension, to the job's status page.

getJobStreamPath

java.lang.String getJobStreamPath(javax.servlet.http.HttpServletRequest request,
                                  JobStatus jobStatus)

Return the full path, including extension, to the job's stream