org.apache.sling.bgservlets
Interface JobConsole


public interface JobConsole

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


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

Method Detail

getJobStatus

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,
                       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

String getJobStatusPagePath(HttpServletRequest request,
                            JobStatus jobStatus,
                            String extension)
Return the full path, including extension, to the job's status page.


getJobStreamPath

String getJobStreamPath(HttpServletRequest request,
                        JobStatus jobStatus)
Return the full path, including extension, to the job's stream



Copyright © 2011-2013 Adobe Systems Incorporated. All Rights Reserved.