[
https://issues.apache.org/jira/browse/KNOX-2053?focusedWorklogId=328645&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-328645
]
ASF GitHub Bot logged work on KNOX-2053:
----------------------------------------
Author: ASF GitHub Bot
Created on: 15/Oct/19 15:34
Start Date: 15/Oct/19 15:34
Worklog Time Spent: 10m
Work Description: risdenk commented on pull request #164: KNOX-2053 - New
REST API to create/read/update/delete service definitions
URL: https://github.com/apache/knox/pull/164#discussion_r335027472
##########
File path:
gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/ServiceDefinitionsResource.java
##########
@@ -0,0 +1,158 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.knox.gateway.service.admin;
+
+import static javax.ws.rs.core.MediaType.APPLICATION_JSON;
+import static javax.ws.rs.core.MediaType.APPLICATION_XML;
+import static javax.ws.rs.core.Response.ok;
+import static javax.ws.rs.core.Response.serverError;
+
+import java.util.HashSet;
+import java.util.Set;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.DELETE;
+import javax.ws.rs.GET;
+import javax.ws.rs.POST;
+import javax.ws.rs.PUT;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.Response;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlElementWrapper;
+
+import org.apache.knox.gateway.service.definition.ServiceDefinitionPair;
+import org.apache.knox.gateway.services.GatewayServices;
+import org.apache.knox.gateway.services.ServiceType;
+import org.apache.knox.gateway.services.registry.ServiceDefinitionRegistry;
+import
org.apache.knox.gateway.services.registry.ServiceDefinitionRegistryException;
+
+@Path("/api/v1")
+public class ServiceDefinitionsResource {
+
+ @Context
+ private HttpServletRequest request;
+
+ private ServiceDefinitionRegistry serviceDefinitionRegistry;
+
+ @GET
+ @Produces({ APPLICATION_JSON, APPLICATION_XML })
+ @Path("servicedefinitions")
+ public ServiceDefinitionsWrapper getServiceDefinitions() {
+ return getServiceDefinitions((Predicate<? super ServiceDefinitionPair>)
null);
+ }
+
+ @GET
+ @Produces({ APPLICATION_JSON, APPLICATION_XML })
+ @Path("servicedefinitions/{name}")
+ public ServiceDefinitionsWrapper getServiceDefinition(@PathParam("name")
String name) {
+ return getServiceDefinitions(serviceDefinitionPair ->
serviceDefinitionPair.getService().getName().equalsIgnoreCase(name));
+ }
+
+ @GET
+ @Produces({ APPLICATION_JSON, APPLICATION_XML })
+ @Path("servicedefinitions/{name}/{role}")
+ public ServiceDefinitionsWrapper getServiceDefinition(@PathParam("name")
String name, @PathParam("role") String role) {
+ return getServiceDefinitions(
+ serviceDefinitionPair ->
serviceDefinitionPair.getService().getName().equalsIgnoreCase(name) &&
serviceDefinitionPair.getService().getRole().equalsIgnoreCase(role));
+ }
+
+ @GET
+ @Produces({ APPLICATION_JSON, APPLICATION_XML })
+ @Path("servicedefinitions/{name}/{role}/{version}")
+ public ServiceDefinitionsWrapper getServiceDefinition(@PathParam("name")
String name, @PathParam("role") String role, @PathParam("version") String
version) {
+ return getServiceDefinitions(serviceDefinitionPair ->
serviceDefinitionPair.getService().getName().equalsIgnoreCase(name)
+ && serviceDefinitionPair.getService().getRole().equalsIgnoreCase(role)
&& serviceDefinitionPair.getService().getVersion().equalsIgnoreCase(version));
+ }
+
+ @POST
+ @Consumes({ APPLICATION_XML })
+ @Produces({ APPLICATION_JSON })
+ @Path("servicedefinitions")
+ public Response saveServiceDefinition(ServiceDefinitionPair
serviceDefinition) {
+ try {
+ getServiceDefinitionRegistry().saveServiceDefinition(serviceDefinition);
+ return ok().entity("{ \"added service definition\": \"" +
serviceDefinition.toString() + "\" }").build();
Review comment:
The only thing I'm not a fan of in the API is the "added service definition"
where it is very verbose coming back to the end user. Usually in an API these
are static unique strings like ERROR_CODE or whatever. Maybe have an id and
then the description?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 328645)
Time Spent: 3h (was: 2h 50m)
> Add Service Definition Management to Admin API
> ----------------------------------------------
>
> Key: KNOX-2053
> URL: https://issues.apache.org/jira/browse/KNOX-2053
> Project: Apache Knox
> Issue Type: Improvement
> Components: Server
> Reporter: Larry McCay
> Assignee: Sandor Molnar
> Priority: Major
> Fix For: 1.4.0
>
> Time Spent: 3h
> Remaining Estimate: 0h
>
> Currently, the Admin API allows management and access to topologies,
> descriptors, provider config, etc but does not provide access to the Service
> Definitions for the proxied services.
> Let's expand the API the include to include service defs and allow for
> customization through the API. Changes made via the API will typically
> require a restart and touch of an topology file that is referencing the
> change service def. This may require a separate Jira and effort to address.
> In the meantime, we should be able to change, add and delete service
> definitions including both service and rewrite XML files.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
