Class JobService

java.lang.Object

com.netscape.cms.servlet.base.PKIService

com.netscape.cms.servlet.base.SubsystemService

org.dogtagpki.server.rest.v1.JobService

All Implemented Interfaces:

JobResource

public class JobService
extends SubsystemService
implements JobResource

Author:

Endi S. Dewata

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	logger

Fields inherited from class PKIService

DEFAULT_LONG_CACHE_LIFETIME, DEFAULT_SIZE, headers, MESSAGE_FORMATS, MIN_FILTER_LENGTH, request, servletContext, servletRequest, uriInfo

Constructor Summary

Constructors

Constructor	Description
JobService()

Method Summary

Modifier and Type	Method	Description
JobInfo	createJobInfo(String id, JobConfig jobConfig, boolean includeDetails)
jakarta.ws.rs.core.Response	findJobs()	Returns all jobs.
jakarta.ws.rs.core.Response	getJob(String id)	Returns a specific job.
jakarta.ws.rs.core.Response	startJob(String id)	Starts a specific job.

Methods inherited from class SubsystemService

audit, auditConfigTokenGeneral, getResourceBundle, getSharedSubsystemConfDir, getSubsystemConfDir, getSubsystemName, getUserMessage

Methods inherited from class PKIService

createCreatedResponse, createNoContentResponse, createOKResponse, createOKResponse, getCMSEngine, getLocale, getParams, getResponseFormat, getResponseFormat, marshall, resolveFormat, resolveFormat, resolveFormat, resolveFormat, sendConditionalGetResponse, unmarshall

Methods inherited from class Object

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

Field Details

logger

public static final org.slf4j.Logger logger

Constructor Details

JobService

public JobService()

Method Details

createJobInfo

public JobInfo createJobInfo(String id,
 JobConfig jobConfig,
 boolean includeDetails)
                      throws EBaseException

Throws:

EBaseException

findJobs

public jakarta.ws.rs.core.Response findJobs()
                                     throws EBaseException

Description copied from interface: JobResource

Returns all jobs. If the method is executed by an admin, it will return all jobs. Otherwise, it will return all jobs owned by the user.

Specified by:

findJobs in interface JobResource

Throws:

EBaseException

getJob

public jakarta.ws.rs.core.Response getJob(String id)
                                   throws EBaseException

Description copied from interface: JobResource

Returns a specific job. This method can only be executed by an admin or the job owner.

Specified by:

getJob in interface JobResource

Throws:

EBaseException

startJob

public jakarta.ws.rs.core.Response startJob(String id)
                                     throws EBaseException

Description copied from interface: JobResource

Starts a specific job. This method can only be executed by an admin or the job owner.

Specified by:

startJob in interface JobResource

Throws:

EBaseException