org.glassfish.admin.rest.resources.TemplateExecCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2015 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 affiliates]
package org.glassfish.admin.rest.resources;
import com.sun.enterprise.util.LocalStringManagerImpl;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.net.URLDecoder;
import org.glassfish.admin.rest.utils.ResourceUtil;
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.ParameterMap;
import jakarta.ws.rs.OPTIONS;
import jakarta.ws.rs.Produces;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.Set;
import jakarta.json.JsonException;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.core.PathSegment;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.Response.Status;
import jakarta.ws.rs.core.UriInfo;
import org.glassfish.jersey.media.sse.EventOutput;
import org.glassfish.admin.rest.Constants;
import org.glassfish.admin.rest.OptionsCapable;
import org.glassfish.admin.rest.composite.CompositeUtil;
import org.glassfish.admin.rest.composite.metadata.RestResourceMetadata;
/**
* @author ludo
*/
public class TemplateExecCommand extends AbstractResource implements OptionsCapable {
public static final LocalStringManagerImpl localStrings = new LocalStringManagerImpl(TemplateExecCommand.class);
protected static final String ERROR = "error";
protected static final String ERROR_STRING = "rest.request.parsing.error";
protected static final String ERROR_DEFAULT_MESSAGE = "Unable to parse the input entity. Please check the syntax.";
protected String resourceName;
protected String commandName;
protected String commandDisplayName;
protected String commandMethod;
protected String commandAction;
protected boolean isLinkedToParent = false;
public TemplateExecCommand(String resourceName, String commandName, String commandMethod, String commandAction,
String commandDisplayName,
boolean isLinkedToParent) {
this.resourceName = resourceName;
this.commandName = commandName;
this.commandMethod = commandMethod;
this.commandAction = commandAction;
this.commandDisplayName = commandDisplayName;
this.isLinkedToParent = isLinkedToParent;
}
@Override
public UriInfo getUriInfo() {
return uriInfo;
}
@Override
public void setUriInfo(UriInfo uriInfo) {
this.uriInfo = uriInfo;
}
@OPTIONS
@Produces({
MediaType.TEXT_HTML,
MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML})
public ActionReportResult optionsLegacyFormat() {
RestActionReporter ar = new RestActionReporter();
ar.setExtraProperties(new Properties());
ar.setActionDescription(commandDisplayName);
OptionsResult optionsResult = new OptionsResult(resourceName);
Map mmd = new HashMap();
MethodMetaData methodMetaData = ResourceUtil.getMethodMetaData(commandName, getCommandParams(),
locatorBridge.getRemoteLocator());
optionsResult.putMethodMetaData(commandMethod, methodMetaData);
mmd.put(commandMethod, methodMetaData);
ResourceUtil.addMethodMetaData(ar, mmd);
ActionReportResult ret = new ActionReportResult(ar, null, optionsResult);
ret.setCommandDisplayName(commandDisplayName);
return ret;
}
@OPTIONS
@Produces(Constants.MEDIA_TYPE_JSON)
public String options() throws JsonException {
return new RestResourceMetadata(this).toJson().toString();
}
protected Response executeCommandAsSse(ParameterMap data) {
EventOutput ec = ResourceUtil.runCommandWithSse(commandName, data, null, null);
return Response.status(HttpURLConnection.HTTP_OK).entity(ec).build();
}
protected Response executeCommandLegacyFormat(ParameterMap data) {
RestActionReporter actionReport = ResourceUtil.runCommand(commandName, data, getSubject());
final ActionReport.ExitCode exitCode = actionReport.getActionExitCode();
final int status = (exitCode == ActionReport.ExitCode.FAILURE) ?
HttpURLConnection.HTTP_INTERNAL_ERROR : HttpURLConnection.HTTP_OK;
ActionReportResult option = optionsLegacyFormat();
ActionReportResult results = new ActionReportResult(commandName, actionReport, option.getMetaData());
results.getActionReport().getExtraProperties().putAll(option.getActionReport().getExtraProperties());
results.setCommandDisplayName(commandDisplayName);
if (exitCode == ActionReport.ExitCode.FAILURE) {
results.setIsError(true);
results.setErrorMessage(actionReport.getCombinedMessage());
}
return Response.status(status).entity(results).build();
}
protected CommandResult executeCommand(ParameterMap data) {
RestActionReporter actionReport = ResourceUtil.runCommand(commandName, data, getSubject());
ActionReport.ExitCode exitCode = actionReport.getActionExitCode();
if (exitCode == ActionReport.ExitCode.FAILURE) {
throw new WebApplicationException(Response.status(Status.INTERNAL_SERVER_ERROR)
.entity(actionReport.getMessage())
.build());
}
CommandResult cr = CompositeUtil.instance().getModel(CommandResult.class);
cr.setMessage(actionReport.getMessage());
cr.setProperties(actionReport.getTopMessagePart().getProps());
cr.setExtraProperties(getExtraProperties(actionReport));
return cr;
}
private Map getExtraProperties(RestActionReporter actionReport) {
Properties props = actionReport.getExtraProperties();
Map map = new HashMap();
for (Map.Entry entry : props.entrySet()) {
map.put(entry.getKey().toString(), entry.getValue());
}
return map;
}
/*override it
*
*
*/
protected HashMap getCommandParams() {
return null;
}
protected void processCommandParams(ParameterMap data) {
HashMap commandParams = getCommandParams();
if (commandParams != null) {
ResourceUtil.resolveParamValues(commandParams, uriInfo);
for (Map.Entry entry : commandParams.entrySet()) {
data.add(entry.getKey(), entry.getValue());
}
}
}
protected void addQueryString(MultivaluedMap qs, ParameterMap data) {
for (Map.Entry> entry : qs.entrySet()) {
String key = entry.getKey();
for (String value : entry.getValue()) {
try {
data.add(key, URLDecoder.decode(value, "UTF-8"));
} catch (UnsupportedEncodingException ex) {
throw new RuntimeException(ex);
}
}
}
}
protected void adjustParameters(ParameterMap data) {
if (data != null) {
if (!(data.containsKey("DEFAULT"))) {
boolean isRenamed = renameParameter(data, "name", "DEFAULT");
if (!isRenamed) {
renameParameter(data, "id", "DEFAULT");
}
}
data.remove("jsoncallback"); //these 2 are for JSONP padding, not needed for CLI execs
data.remove("_");
}
}
protected boolean renameParameter(ParameterMap data, String parameterToRename, String newName) {
if ((data.containsKey(parameterToRename))) {
List value = data.get(parameterToRename);
data.remove(parameterToRename);
data.set(newName, value);
return true;
}
return false;
}
protected void purgeEmptyEntries(ParameterMap data) {
HashSet keyToRemove = new HashSet();
Set>> entries = data.entrySet();
for (Entry> entry : entries) {
if ((entry.getValue() == null) || (entry.getValue().isEmpty())) {
keyToRemove.add(entry.getKey());
}
}
if ("true".equals(data.getOne("__remove_empty_entries__"))) {
data.remove("__remove_empty_entries__");
//now remove list of 1 element which is "" only
Set>> entries2 = data.entrySet();
//temp list to avoid Concurrent Modification Exception
for (Entry> entry : entries2) {
if (entry.getValue().size() == 1) {
if (entry.getValue().get(0).equals("")) {
keyToRemove.add(entry.getKey());
}
}
}
}
for (String k : keyToRemove) {
data.remove(k);
}
}
protected String getParent(UriInfo uriInfo) {
List segments = uriInfo.getPathSegments(true);
return segments.get(segments.size()-2).getPath();
}
}