org.glassfish.admin.rest.resources.TemplateListOfResource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-2016 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.
*/
// Portions Copyright [2016-2021] [Payara Foundation and/or its affiliates]
package org.glassfish.admin.rest.resources;
import java.lang.reflect.Method;
import org.glassfish.config.support.Create;
import java.net.HttpURLConnection;
import com.sun.enterprise.util.LocalStringManagerImpl;
import org.glassfish.admin.rest.utils.ResourceUtil;
import org.glassfish.admin.rest.utils.Util;
import org.glassfish.admin.rest.provider.MethodMetaData;
import org.glassfish.admin.rest.results.ActionReportResult;
import org.glassfish.admin.rest.results.OptionsResult;
import org.glassfish.admin.rest.utils.xml.RestActionReporter;
import org.glassfish.api.ActionReport;
import org.glassfish.api.admin.RestRedirect;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.ConfigModel;
import org.jvnet.hk2.config.Dom;
import org.jvnet.hk2.config.DomDocument;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.DefaultValue;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.OPTIONS;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.Context;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import org.glassfish.hk2.api.MultiException;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.jersey.media.multipart.FormDataMultiPart;
import static org.glassfish.admin.rest.utils.Util.decode;
import static org.glassfish.admin.rest.utils.Util.getName;
/**
* @author Ludovic Champenois [email protected]
* @author Rajeshwar Patil
*/
public abstract class TemplateListOfResource extends AbstractResource {
@Context
protected ServiceLocator injector;
protected List entity;
protected Dom parent;
protected String tagName;
public static final LocalStringManagerImpl localStrings = new LocalStringManagerImpl(TemplateListOfResource.class);
@GET
@Produces({MediaType.TEXT_HTML, MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
public Response get(@QueryParam("expandLevel") @DefaultValue("1") int expandLevel) {
return Response.ok().entity(buildActionReportResult()).build();
}
@POST
//create
@Produces({MediaType.TEXT_HTML,
MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML})
@Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML,
MediaType.APPLICATION_FORM_URLENCODED})
public Response createResource(HashMap data) {
if (data == null) {
data = new HashMap();
}
try {
if (data.containsKey("error")) {
String errorMessage = localStrings.getLocalString("rest.request.parsing.error",
"Unable to parse the input entity. Please check the syntax.");
ActionReportResult arr = ResourceUtil.getActionReportResult(ActionReport.ExitCode.FAILURE, errorMessage, requestHeaders, uriInfo);
return Response.status(400).entity(arr).build();
}
ResourceUtil.purgeEmptyEntries(data);
//Command to execute
String commandName = getPostCommand();
String resourceToCreate = uriInfo.getAbsolutePath() + "/";
if (null != commandName) {
ResourceUtil.adjustParameters(data); //adjusting for DEFAULT is required only while executing a CLI command
if (data.containsKey("name")) {
resourceToCreate += data.get("name");
} else {
resourceToCreate += data.get("DEFAULT");
}
RestActionReporter actionReport = ResourceUtil.runCommand(commandName, data, getSubject());
ActionReport.ExitCode exitCode = actionReport.getActionExitCode();
if (exitCode != ActionReport.ExitCode.FAILURE) {
String successMessage =
localStrings.getLocalString("rest.resource.create.message",
"\"{0}\" created successfully.", resourceToCreate);
ActionReportResult arr = ResourceUtil.getActionReportResult(actionReport, successMessage, requestHeaders, uriInfo);
return Response.ok(arr).build();
}
String errorMessage = getErrorMessage(data, actionReport);
ActionReportResult arr = ResourceUtil.getActionReportResult(actionReport, errorMessage, requestHeaders, uriInfo);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(arr).build();
} else {
ActionReportResult arr = ResourceUtil.getActionReportResult(ActionReport.ExitCode.FAILURE, "No CRUD Create possible.", requestHeaders, uriInfo);
return Response.status(HttpURLConnection.HTTP_INTERNAL_ERROR).entity(arr).build();
}
} catch (Exception e) {
throw new WebApplicationException(e, Response.Status.INTERNAL_SERVER_ERROR);
}
}
@POST
@Consumes(MediaType.MULTIPART_FORM_DATA)
public Response post(FormDataMultiPart formData) {
/* data passed to the generic command running
*
* */
HashMap data = TemplateRestResource.createDataBasedOnForm(formData);
return createResource(data, data.get("name")); //execute the deploy command with a copy of the file locally
}
@OPTIONS
@Produces({MediaType.APPLICATION_JSON, MediaType.TEXT_HTML, MediaType.APPLICATION_XML})
public Response options() {
return Response.ok().entity(buildActionReportResult()).build();
}
public void setEntity(List p) {
entity = p;
}
public List getEntity() {
return entity;
}
public void setParentAndTagName(Dom parent, String tagName) {
this.parent = parent;
this.tagName = tagName;
if (parent != null) {
synchronized (parent) {
entity = parent.nodeElements(tagName);
}
}
}
/**
* allows for remote files to be put in a tmp area and we pass the
* local location of this file to the corresponding command instead of the content of the file
* * Yu need to add enctype="multipart/form-data" in the form
* for ex: <form action="http://localhost:4848/management/domain/applications/application" method="post" enctype="multipart/form-data">
* then any param of type="file" will be uploaded, stored locally and the param will use the local location
* on the server side (ie. just the path)
*/
public String getPostCommand() {
ConfigModel.Property p = parent.model.getElement(tagName);
if (p == null) { //"*"
ConfigModel.Property childElement = parent.model.getElement("*");
if (childElement != null) {
ConfigModel.Node node = (ConfigModel.Node) childElement;
ConfigModel childModel = node.getModel();
List subChildConfigModels = ResourceUtil.getRealChildConfigModels(childModel, parent.document);
for (ConfigModel subChildConfigModel : subChildConfigModels) {
if (subChildConfigModel.getTagName().equals(tagName)) {
return ResourceUtil.getCommand(RestRedirect.OpType.POST, subChildConfigModel);
}
}
}
} else {
ConfigModel.Node n = (ConfigModel.Node) p;
String command =
ResourceUtil.getCommand(RestRedirect.OpType.POST, n.getModel());
if (command!=null){
return command;
}
//last possible case...the @Create annotation on a parent method
Class cbp = null;
try {
cbp = (Class) parent.model.classLoaderHolder.loadClass(parent.model.targetTypeName);
} catch (MultiException e) {
return null;//
}
Create create = null;
for (Method m : cbp.getMethods()) {
ConfigModel.Property pp = parent.model.toProperty(m);
if ((pp != null) && (pp.xmlName.equals(tagName)) && (m.isAnnotationPresent(Create.class))) {
create = m.getAnnotation(Create.class);
break;
}
}
if (create != null) {
return create.value();
}
}
return null;
}
public String[][] getCommandResourcesPaths() {
return new String[][]{};
}
public static Class getElementTypeByName(Dom parentDom, String elementName)
throws ClassNotFoundException {
DomDocument document = parentDom.document;
ConfigModel.Property a = parentDom.model.getElement(elementName);
if (a != null) {
if (a.isLeaf()) {
// : I am not too sure, but that should be a String @Element
return null;
} else {
ConfigModel childModel = ((ConfigModel.Node) a).getModel();
return (Class) childModel.classLoaderHolder.loadClass(childModel.targetTypeName);
}
}
// global lookup
ConfigModel model = document.getModelByElementName(elementName);
if (model != null) {
return (Class) model.classLoaderHolder.loadClass(model.targetTypeName);
}
return null;
}
protected ActionReportResult buildActionReportResult() {
if (entity == null) {//wrong resource
String errorMessage = localStrings.getLocalString("rest.resource.erromessage.noentity",
"Resource not found.");
return ResourceUtil.getActionReportResult(ActionReport.ExitCode.FAILURE, errorMessage, requestHeaders, uriInfo);
}
RestActionReporter ar = new RestActionReporter();
final String typeKey = (decode(getName(uriInfo.getPath(), '/')));
ar.setActionDescription(typeKey);
OptionsResult optionsResult = new OptionsResult(Util.getResourceName(uriInfo));
Map mmd = getMethodMetaData();
optionsResult.putMethodMetaData("GET", mmd.get("GET"));
optionsResult.putMethodMetaData("POST", mmd.get("POST"));
ResourceUtil.addMethodMetaData(ar, mmd);
ar.getExtraProperties().put("childResources", ResourceUtil.getResourceLinks(getEntity(), uriInfo));
ar.getExtraProperties().put("commands", ResourceUtil.getCommandLinks(getCommandResourcesPaths()));
// FIXME: I'd rather not keep using OptionsResult, but I don't have the time at this point to do it "right." This is
// an internal impl detail, so it can wait
return new ActionReportResult(ar, optionsResult);
}
//called in case of POST on application resource (deployment).
//resourceToCreate is the name attribute if provided.
private Response createResource(HashMap data, String resourceToCreate) {
try {
if (data.containsKey("error")) {
String errorMessage = localStrings.getLocalString("rest.request.parsing.error",
"Unable to parse the input entity. Please check the syntax.");
return Response.status(400).entity(ResourceUtil.getActionReportResult(ActionReport.ExitCode.FAILURE, errorMessage, requestHeaders, uriInfo)).build();
}
ResourceUtil.purgeEmptyEntries(data);
//Command to execute
String commandName = getPostCommand();
ResourceUtil.defineDefaultParameters(data);
if ((resourceToCreate == null) || (resourceToCreate.equals(""))) {
String newResourceName = data.get("DEFAULT");
if (newResourceName != null) {
if (newResourceName.contains("/")) {
newResourceName = Util.getName(newResourceName, '/');
} else {
if (newResourceName.contains("\\")) {
newResourceName = Util.getName(newResourceName, '\\');
}
}
resourceToCreate = uriInfo.getAbsolutePath() + "/" + newResourceName;
}
} else {
resourceToCreate = uriInfo.getAbsolutePath() + "/" + resourceToCreate;
}
if (null != commandName) {
RestActionReporter actionReport = ResourceUtil.runCommand(commandName, data, getSubject());
ActionReport.ExitCode exitCode = actionReport.getActionExitCode();
if (exitCode != ActionReport.ExitCode.FAILURE) {
String successMessage = localStrings.getLocalString("rest.resource.create.message",
"\"{0}\" created successfully.", resourceToCreate);
return Response.ok().entity(ResourceUtil.getActionReportResult(actionReport, successMessage, requestHeaders, uriInfo)).build();
}
String errorMessage = getErrorMessage(data, actionReport);
return Response.status(400).entity(ResourceUtil.getActionReportResult(actionReport, errorMessage, requestHeaders, uriInfo)).build();
}
String message = localStrings.getLocalString("rest.resource.post.forbidden", "POST on \"{0}\" is forbidden.", resourceToCreate);
return Response.status(403).entity(ResourceUtil.getActionReportResult(ActionReport.ExitCode.FAILURE, message, requestHeaders, uriInfo)).build();
} catch (Exception e) {
throw new WebApplicationException(e, Response.Status.INTERNAL_SERVER_ERROR);
}
}
private Map getMethodMetaData() {
Map map = new TreeMap();
//GET meta data
map.put("GET", new MethodMetaData());
//POST meta data
String command = getPostCommand();
if (command != null) {
MethodMetaData postMethodMetaData = ResourceUtil.getMethodMetaData(command, locatorBridge.getRemoteLocator());
if (Util.getResourceName(uriInfo).equals("Application")) {
postMethodMetaData.setIsFileUploadOperation(true);
}
map.put("POST", postMethodMetaData);
}
return map;
}
private String getErrorMessage(HashMap data, ActionReport ar) {
return ar.getMessage();
}
}