org.glassfish.admin.rest.resources.composite.JobResource Maven / Gradle / Ivy
Show all versions of payara-embedded-web Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.admin.rest.resources.composite;
import com.sun.enterprise.v3.admin.commands.ListJobsCommand;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.Response;
import org.glassfish.admin.rest.composite.CompositeResource;
import org.glassfish.admin.rest.model.RestModelResponseBody;
import org.glassfish.admin.rest.utils.StringUtil;
import org.glassfish.api.ActionReport;
import org.glassfish.api.admin.ParameterMap;
/**
* 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
*/
public class JobResource extends CompositeResource {
/**
* Retrieve information about the specific job identified by the resource URL.
*
* Roles: PaasAdmin, TenantAdmin
*
* @param jobId
* @return the {@link Job} entity which contains information about the job id specified.
*/
@GET
public RestModelResponseBody getItem(@PathParam("jobId") String jobId) throws Exception {
ActionReport ar = executeReadCommand(getCommandName(), getParameters());
Collection> jobMaps = (List>) ar.getExtraProperties().get("jobs");
if (jobMaps != null) {
for (Map jobMap : jobMaps) {
if (StringUtil.compareStrings(jobId, (String) jobMap.get(ListJobsCommand.ID))) {
Job model = JobsResource.constructJobModel(jobMap);
return restModelResponseBody(Job.class, getCollectionChildParentUri(), model);
}
}
}
throw new WebApplicationException(Response.Status.NOT_FOUND);
}
protected String getCommandName() {
return "list-jobs";
}
protected ParameterMap getParameters() {
return new ParameterMap();
}
}