Package org.xwiki.filemanager.job

Class PackJobStatus

java.lang.Object
org.xwiki.job.AbstractJobStatus<PackRequest>
org.xwiki.filemanager.job.PackJobStatus
All Implemented Interfaces:
org.xwiki.job.event.status.CancelableJobStatus, org.xwiki.job.event.status.JobStatus
@Unstable public class PackJobStatus extends org.xwiki.job.AbstractJobStatus<PackRequest>
The status of a job that executes a PackRequest.
Since:
2.0M2
Version:
$Id$

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.xwiki.job.event.status.JobStatus

    org.xwiki.job.event.status.JobStatus.State

  • Constructor Summary

    Constructors
    Constructor
    Description
    PackJobStatus(String jobType, PackRequest request, org.xwiki.job.event.status.JobStatus parentJobStatus, org.xwiki.observation.ObservationManager observationManager, org.xwiki.logging.LoggerManager loggerManager)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getBytesWritten()
     
    String
    getDownloadURL()
     
    long
    getOutputFileSize()
     
    void
    setBytesWritten(long bytesWritten)
    Sets the number of bytes written so far in the output ZIP file.
    void
    setDownloadURL(String downloadURL)
    Sets the URL used to download the output ZIP file.
    void
    setOutputFileSize(long outputFileSize)
    Sets the actual size (in bytes) of the output file, after the ZIP compression.

    Methods inherited from class org.xwiki.job.AbstractJobStatus

    answered, ask, ask, cancel, getEndDate, getError, getJobType, getLog, getLog, getLoggerTail, getLogTail, getParentJobStatus, getProgress, getQuestion, getQuestionTimeLeft, getRequest, getStartDate, getState, ignoreLogs, isCancelable, isCanceled, isIsolated, isSerialized, isSubJob, setCancelable, setEndDate, setError, setIsolated, setLoggerTail, setParentJobStatus, setStartDate, setState, startListening, stopListening

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PackJobStatus

      public PackJobStatus(String jobType, PackRequest request, org.xwiki.job.event.status.JobStatus parentJobStatus, org.xwiki.observation.ObservationManager observationManager, org.xwiki.logging.LoggerManager loggerManager)
      Parameters:
      jobType - the type of the job
      request - the request provided when started the job
      parentJobStatus - the status of the parent job (i.e. the status of the job that started this one); pass null if this job hasn't been started by another job (i.e. if this is not a sub-job)
      observationManager - the observation manager component
      loggerManager - the logger manager component

  • Method Details

    • getBytesWritten

      public long getBytesWritten()
      Returns:
      the number of bytes written so far in the output ZIP file

    • setBytesWritten

      public void setBytesWritten(long bytesWritten)
      Sets the number of bytes written so far in the output ZIP file.
      Parameters:
      bytesWritten - the number of bytes written so far

    • getOutputFileSize

      public long getOutputFileSize()
      Returns:
      the actual size (in bytes) of the output file, after the ZIP compression

    • setOutputFileSize

      public void setOutputFileSize(long outputFileSize)
      Sets the actual size (in bytes) of the output file, after the ZIP compression.
      Parameters:
      outputFileSize - the size, in bytes, of the output ZIP file

    • getDownloadURL

      public String getDownloadURL()
      Returns:
      the URL used to download the output ZIP file

    • setDownloadURL

      public void setDownloadURL(String downloadURL)
      Sets the URL used to download the output ZIP file.
      Parameters:
      downloadURL - the URL used to download the output ZIP file