dk.netarkivet.harvester.webinterface
Class HarvestStatus

java.lang.Object
  extended by dk.netarkivet.harvester.webinterface.HarvestStatus

public class HarvestStatus
extends java.lang.Object

This page provides support for the HarvestStatus pages of the web interface.


Nested Class Summary
static class HarvestStatus.DefaultedRequest
          This class encapsulates a request for reload, making non-existing parameters appear as there default value.
 
Field Summary
static java.lang.String DEFAULT_JOBSTATUS
          Default Jobstatus (STARTED).
static java.lang.String DEFAULT_SORTORDER
          Default sortorder (ascending).
static java.lang.String[] DEFAULTABLE_PARAMETERS
          Parameters used by the Harveststatus-alljobs.jsp page.
static java.lang.String JOBSTATUS_ALL
          The String code to select all states.
static java.lang.String SORTORDER_ASCENDING
          Ascending sort order for job id.
static java.lang.String SORTORDER_DESCENDING
          Descending sort order for job id.
 
Constructor Summary
HarvestStatus()
           
 
Method Summary
static java.util.List<JobStatusInfo> getjobStatusList(long harvestId, long harvestNum, java.util.Set<java.lang.Integer> selectedJobStatusCodes, java.lang.String selectedSortOrder)
          Calculate list of job information to be shown.
static java.util.List<JobStatusInfo> getjobStatusList(java.util.Set<java.lang.Integer> selectedJobStatusCodes, java.lang.String selectedSortOrder)
          Calculate list of job information to be shown.
static java.util.Set<java.lang.Integer> getSelectedJobStatusCodes(HarvestStatus.DefaultedRequest dfltRequest)
          Find Job status to be shown based on parameters, including possibility for All statuses.
static java.lang.String getSelectedSortOrder(HarvestStatus.DefaultedRequest dfltRequest)
          Find sort order of job ids to be shown based on parameters.
static java.lang.String makeHarvestRunLink(long harvestID, int harvestRun)
          Create a link to the harvest-run page for a given run.
static void processRequest(javax.servlet.jsp.PageContext context, I18n i18n)
          Process a request from Harveststatus-alljobs.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULTABLE_PARAMETERS

public static final java.lang.String[] DEFAULTABLE_PARAMETERS
Parameters used by the Harveststatus-alljobs.jsp page.


SORTORDER_ASCENDING

public static final java.lang.String SORTORDER_ASCENDING
Ascending sort order for job id.

See Also:
Constant Field Values

SORTORDER_DESCENDING

public static final java.lang.String SORTORDER_DESCENDING
Descending sort order for job id.

See Also:
Constant Field Values

JOBSTATUS_ALL

public static final java.lang.String JOBSTATUS_ALL
The String code to select all states.

See Also:
Constant Field Values

DEFAULT_SORTORDER

public static final java.lang.String DEFAULT_SORTORDER
Default sortorder (ascending).

See Also:
Constant Field Values

DEFAULT_JOBSTATUS

public static final java.lang.String DEFAULT_JOBSTATUS
Default Jobstatus (STARTED).

Constructor Detail

HarvestStatus

public HarvestStatus()
Method Detail

processRequest

public static void processRequest(javax.servlet.jsp.PageContext context,
                                  I18n i18n)
                           throws ForwardedToErrorPage
Process a request from Harveststatus-alljobs. Will resubmit a job if requested, otherwise do nothing.

Parameters:
context - The web context used for processing
i18n - The resource i18n context.
Throws:
ForwardedToErrorPage - If an error occurs that stops processing and forwards the user to an error page.

makeHarvestRunLink

public static java.lang.String makeHarvestRunLink(long harvestID,
                                                  int harvestRun)
Create a link to the harvest-run page for a given run.

Parameters:
harvestID - The ID of the harvest
harvestRun - The run # of the harvest (always 0 for snapshots)
Returns:
A properly encoded HTML string with a link and the harvest run as the text. Select all jobs to be shown.

getSelectedJobStatusCodes

public static java.util.Set<java.lang.Integer> getSelectedJobStatusCodes(HarvestStatus.DefaultedRequest dfltRequest)
Find Job status to be shown based on parameters, including possibility for All statuses.

Parameters:
dfltRequest - contains defaulted parameters
Returns:
Integer value being the ordinal of a JobStatus or -1 for ALL (job statuses)
Throws:
ArgumentNotValid, - IllegalArgumentException

getSelectedSortOrder

public static java.lang.String getSelectedSortOrder(HarvestStatus.DefaultedRequest dfltRequest)
Find sort order of job ids to be shown based on parameters.

Parameters:
dfltRequest - contains defaulted parameters
Returns:
String constant for selected order
Throws:
ArgumentNotValid

getjobStatusList

public static java.util.List<JobStatusInfo> getjobStatusList(java.util.Set<java.lang.Integer> selectedJobStatusCodes,
                                                             java.lang.String selectedSortOrder)
Calculate list of job information to be shown.

Parameters:
selectedJobStatusCodes - integer codes for job statuses to be shown
selectedSortOrder - string code whether job ids should come in asc. or desc. order
Returns:
list of job (status) information to be shown
Throws:
ArgumentNotValid

getjobStatusList

public static java.util.List<JobStatusInfo> getjobStatusList(long harvestId,
                                                             long harvestNum,
                                                             java.util.Set<java.lang.Integer> selectedJobStatusCodes,
                                                             java.lang.String selectedSortOrder)
Calculate list of job information to be shown.

Parameters:
harvestId - Select only jobs generated from this harvestdefinition
harvestNum - Select only jobs with this harvestNumber.
selectedJobStatusCodes - integer codes for job statuses to be shown
selectedSortOrder - string code whether job ids should come in asc. or desc. order
Returns:
list of job (status) information to be shown
Throws:
ArgumentNotValid - If some of the arguments are invalid