org.glassfish.admin.rest.resources.composite

Class JobResource

java.lang.Object

org.glassfish.admin.rest.resources.AbstractResource

org.glassfish.admin.rest.composite.CompositeResource

org.glassfish.admin.rest.resources.composite.JobResource

All Implemented Interfaces:

RestResource

public class JobResource
extends CompositeResource

This resource is used to view the current state of a specific job.

Example Interactions

View a specific detached job

$ curl --user admin:admin123 -v \ -H Accept:application/vnd.oracle.glassfish+json \ -H Content-Type:application/vnd.oracle.glassfish+json \ -H X-Requested-By:MyClient \ http://localhost:4848/management/jobs/id/1 HTTP/1.1 200 OK { "exitCode": "COMPLETED", "jobId": "1", "jobName": "load-sdp", "jobState": "COMPLETED", "executionDate": "Wed Jan 02 11:36:38 CST 2013", "message": "SDP loaded with name nucleusSDP.", "user": "admin" }

Author:

jdlee

Nested Class Summary

Nested classes/interfaces inherited from class org.glassfish.admin.rest.composite.CompositeResource

CompositeResource.CommandInvoker, CompositeResource.CreateCommandInvoker

Field Summary

Fields inherited from class org.glassfish.admin.rest.composite.CompositeResource

compositeUtil, CONSUMES_TYPE, DETACHED, DETACHED_DEFAULT, EXCLUDE, INCLUDE, THREAD_POOL_CORE, THREAD_POOL_MAX

Fields inherited from class org.glassfish.admin.rest.resources.AbstractResource

locatorBridge, logger, requestHeaders, securityContext, serviceLocator, subjectRef, uriInfo

Constructor Summary

Constructors

Constructor and Description
JobResource()

Method Summary

Modifier and Type	Method and Description
protected String	getCommandName()
RestModelResponseBody<Job>	getItem(String jobId) Retrieve information about the specific job identified by the resource URL.
protected ParameterMap	getParameters()

Methods inherited from class org.glassfish.admin.rest.composite.CompositeResource

accepted, accepted, accepted, accepted, act, acted, acted, acted, actSse, addActionResourceLink, addResourceLink, badRequest, badRequest, badRequest, badRequest, create, created, created, created, created, createSse, deleted, deleted, deleted, executeCommand, executeDeleteCommand, executeDeleteCommand, executeDeleteCommandManaged, executeReadCommand, executeReadCommand, executeSseCommand, executeSseCommand, executeSseCommand, executeWriteCommand, executeWriteCommand, executeWriteCommandManaged, filterModel, filterModel, filterModel, generateDefaultName, getChildItemUri, getCollectionChildParentUri, getCompositeUtil, getExecutorService, getFilter, getFilter, getJsonModel, getLocale, getParentUri, getPathParam, getResponse, getResponse, getSubResource, getSubUri, getTypedModel, getUri, includeResourceLinks, launchDetachedCommand, newModel, newTemplate, notFound, ok, parameterMap, responseBody, restCollectionResponseBody, restCollectionResponseBody, restModelResponseBody, restModelResponseBody, restModelResponseBody, setSubjectRef, updated, updated, updated

Methods inherited from class org.glassfish.admin.rest.resources.AbstractResource

getAuthenticatedUser, getSubject

Methods inherited from class java.lang.Object

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

Constructor Detail

JobResource

public JobResource()

Method Detail

getItem

@GET
public RestModelResponseBody<Job> getItem(@PathParam(value="jobId")
                                               String jobId)
                                        throws Exception

Retrieve information about the specific job identified by the resource URL.

Roles: PaasAdmin, TenantAdmin

Parameters:

jobId -

Returns:

the Job entity which contains information about the job id specified.

Throws:

Exception

getCommandName

protected String getCommandName()

getParameters

protected ParameterMap getParameters()