ListJobsCommand (Payara Project 4.1.2.174 API)

java.lang.Object
- com.sun.enterprise.v3.admin.commands.ListJobsCommand

All Implemented Interfaces:

AdminCommand, AdminCommandSecurity.AccessCheckProvider
```
@Service(name="list-jobs")
 @PerLookup
public class ListJobsCommand
extends Object
implements AdminCommand, AdminCommandSecurity.AccessCheckProvider
```
This command will list the jobs related information Currently it prints the jobId, name, time of execution,user and the state

Author:

Bhakti Mehta

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CODE`
`static String`	`COMPLETION_DATE`
`static String`	`DATE`
`static String`	`ID`
`static String`	`MESSAGE`
`static String`	`NAME`
`static String`	`STATE`
`protected static String`	`TITLE_EXITCODE`
`protected static String`	`TITLE_JOBID`
`protected static String`	`TITLE_NAME`
`protected static String`	`TITLE_NONE`
`protected static String`	`TITLE_STATE`
`protected static String`	`TITLE_TIME`
`protected static String`	`TITLE_USER`
`static String`	`USER`

Constructor Summary

Constructors
Constructor and Description

ListJobsCommand()

Constructors
Constructor and Description
`ListJobsCommand()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`checkScope(Job job)`
`void`	`display(Collection<JobInfo> jobInfoList, AdminCommandContext context)`
`void`	`execute(AdminCommandContext context)` Executes the command with the command parameters passed as Properties where the keys are the parameter names and the values are the parameter values
`Collection<? extends AccessRequired.AccessCheck>`	`getAccessChecks()` Returns the `AccessCheck`s the command has computed at runtime which should be included in the authorization, added to checks that secure admin infers from the command's CRUD or RestEndpoint characteristics or `AccessRequired` annotations.
`protected JobInfo`	`getCompletedJobForId(String jobID)`
`protected JobInfos`	`getCompletedJobs()`
`protected boolean`	`isJobEligible(Job job)`
`protected boolean`	`isSingleJobOK(Job singleJob)`
`static boolean`	`skipJob(String name)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TITLE_NAME
```
protected static final String TITLE_NAME
```
    See Also:
    
    Constant Field Values
  - TITLE_JOBID
```
protected static final String TITLE_JOBID
```
    See Also:
    
    Constant Field Values
  - TITLE_TIME
```
protected static final String TITLE_TIME
```
    See Also:
    
    Constant Field Values
  - TITLE_STATE
```
protected static final String TITLE_STATE
```
    See Also:
    
    Constant Field Values
  - TITLE_EXITCODE
```
protected static final String TITLE_EXITCODE
```
    See Also:
    
    Constant Field Values
  - TITLE_USER
```
protected static final String TITLE_USER
```
    See Also:
    
    Constant Field Values
  - TITLE_NONE
```
protected static final String TITLE_NONE
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - ID
```
public static final String ID
```
    See Also:
    
    Constant Field Values
  - DATE
```
public static final String DATE
```
    See Also:
    
    Constant Field Values
  - CODE
```
public static final String CODE
```
    See Also:
    
    Constant Field Values
  - USER
```
public static final String USER
```
    See Also:
    
    Constant Field Values
  - STATE
```
public static final String STATE
```
    See Also:
    
    Constant Field Values
  - MESSAGE
```
public static final String MESSAGE
```
    See Also:
    
    Constant Field Values
  - COMPLETION_DATE
```
public static final String COMPLETION_DATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ListJobsCommand
```
public ListJobsCommand()
```
- Method Detail
  - getCompletedJobs
```
protected JobInfos getCompletedJobs()
```
  - getCompletedJobForId
```
protected JobInfo getCompletedJobForId(String jobID)
```
  - isSingleJobOK
```
protected boolean isSingleJobOK(Job singleJob)
```
  - isJobEligible
```
protected boolean isJobEligible(Job job)
```
  - checkScope
```
protected boolean checkScope(Job job)
```
  - execute
```
public void execute(AdminCommandContext context)
```
    Description copied from interface: AdminCommand
    
    Executes the command with the command parameters passed as Properties where the keys are the parameter names and the values are the parameter values
    
    Specified by:
    
    execute in interface AdminCommand
    
    Parameters:
    
    context - information
  - skipJob
```
public static boolean skipJob(String name)
```
  - getAccessChecks
```
public Collection<? extends AccessRequired.AccessCheck> getAccessChecks()
```
    Description copied from interface: AdminCommandSecurity.AccessCheckProvider
    
    Returns the AccessChecks the command has computed at runtime which should be included in the authorization, added to checks that secure admin infers from the command's CRUD or RestEndpoint characteristics or AccessRequired annotations.
    
    Specified by:
    
    getAccessChecks in interface AdminCommandSecurity.AccessCheckProvider
    
    Returns:
    
    the AccessChecks
  - display
```
public void display(Collection<JobInfo> jobInfoList,
                    AdminCommandContext context)
```

Class ListJobsCommand

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TITLE_NAME

TITLE_JOBID

TITLE_TIME

TITLE_STATE

TITLE_EXITCODE

TITLE_USER

TITLE_NONE

NAME

ID

DATE

CODE

USER

STATE

MESSAGE

COMPLETION_DATE

Constructor Detail

ListJobsCommand

Method Detail

getCompletedJobs

getCompletedJobForId

isSingleJobOK

isJobEligible

checkScope

execute

skipJob

getAccessChecks

display