org.glassfish.admin.rest.resources.LeafResource 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) 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 its affiliates]
package org.glassfish.admin.rest.resources;
import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.DefaultValue;
import jakarta.ws.rs.DELETE;
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 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 com.sun.enterprise.util.LocalStringManagerImpl;
import org.glassfish.admin.rest.utils.ResourceUtil;
import org.glassfish.admin.rest.utils.Util;
import org.jvnet.hk2.config.Dom;
import static org.glassfish.admin.rest.utils.Util.decode;
/**
* @author Ludovic Champenois
*/
public abstract class LeafResource extends AbstractResource {
protected LeafContent entity;
protected Dom parent;
protected String tagName;
public static final LocalStringManagerImpl localStrings = new LocalStringManagerImpl(LeafResource.class);
/** Creates a new instance of xxxResource */
public LeafResource() {
}
public void setEntity(LeafContent p) {
entity = p;
}
public LeafContent getEntity() {
return entity;
}
public void setParentAndTagName(Dom parent, String tagName) {
this.parent = parent;
this.tagName = tagName;
entity = new LeafContent();
entity.name = tagName;
synchronized (parent) {
entity.value = parent.leafElement(tagName);
}
}
@GET
@Produces({MediaType.TEXT_HTML, MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.APPLICATION_FORM_URLENCODED})
public ActionReportResult get(@QueryParam("expandLevel") @DefaultValue("1") int expandLevel) {
if (getEntity() == null) {
throw new WebApplicationException(Response.Status.NOT_FOUND);
}
return buildActionReportResult();
}
@POST //create
@Produces({MediaType.TEXT_HTML, MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.APPLICATION_FORM_URLENCODED})
@Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.APPLICATION_FORM_URLENCODED})
public ActionReportResult create(HashMap data) {
//hack-1 : support delete method for html
//Currently, browsers do not support delete method. For html media,
//delete operations can be supported through POST. Redirect html
//client POST request for delete operation to DELETE method.
if ((data.containsKey("operation")) &&
(data.get("operation").equals("__deleteoperation"))) {
data.remove("operation");
return delete(data);
}
return null;
//TODO
//// String postCommand = getPostCommand();
//// final Map payload = processData(data, postCommand);
////
//// return runCommand(postCommand, payload, "rest.resource.create.message",
//// "\"{0}\" created successfully.", "rest.resource.post.forbidden","POST on \"{0}\" is forbidden.");
}
@DELETE //delete
@Produces({MediaType.TEXT_HTML, MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.APPLICATION_FORM_URLENCODED})
@Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.APPLICATION_FORM_URLENCODED})
public ActionReportResult delete(HashMap data) {
ResourceUtil.addQueryString(uriInfo.getQueryParameters(), data);
return null;//TODOTODO
}
@OPTIONS
@Produces({MediaType.TEXT_HTML, MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
public ActionReportResult options() {
return buildActionReportResult();
}
protected ActionReportResult buildActionReportResult() {
RestActionReporter ar = new RestActionReporter();
final String typeKey = (decode(getName()));
ar.setActionDescription(typeKey);
ar.getExtraProperties().put("entityLeaf", getEntity());
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);
ActionReportResult r= new ActionReportResult(ar, optionsResult);
r.setLeafContent(entity);
return r;
}
protected Map getMethodMetaData() {
Map mmd = new TreeMap();
//GET meta data
mmd.put("GET", new MethodMetaData());
return mmd;
}
protected String getName() {
return Util.getResourceName(uriInfo);
}
public static class LeafContent {
public String name;
public String value;
}
}