[
https://issues.apache.org/jira/browse/KNOX-2226?focusedWorklogId=394413&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-394413
]
ASF GitHub Bot logged work on KNOX-2226:
----------------------------------------
Author: ASF GitHub Bot
Created on: 27/Feb/20 19:09
Start Date: 27/Feb/20 19:09
Worklog Time Spent: 10m
Work Description: risdenk commented on pull request #263: KNOX-2226 - Add
home page to Knox
URL: https://github.com/apache/knox/pull/263#discussion_r385313226
##########
File path:
gateway-service-metadata/src/main/java/org/apache/knox/gateway/service/metadata/ServiceModel.java
##########
@@ -0,0 +1,121 @@
+/*
+ * 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.metadata;
+
+import java.util.Locale;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+import org.apache.knox.gateway.service.definition.Metadata;
+import org.apache.knox.gateway.topology.Service;
+
+@XmlRootElement(name = "service")
+@XmlAccessorType(XmlAccessType.NONE)
+public class ServiceModel {
+
+ public enum Type {
+ API, UI, UNKNOWN
+ };
+
+ protected HttpServletRequest request;
+ protected String topologyName;
+ protected String gatewayPath;
+ protected Service service;
+ protected Metadata serviceMetadata;
+
+ public void setRequest(HttpServletRequest request) {
+ this.request = request;
+ }
+
+ public void setTopologyName(String topologyName) {
+ this.topologyName = topologyName;
+ }
+
+ public void setGatewayPath(String gatewayPath) {
+ this.gatewayPath = gatewayPath;
+ }
+
+ public void setService(Service service) {
+ this.service = service;
+ }
+
+ public void setServiceMetadata(Metadata serviceMetadata) {
+ this.serviceMetadata = serviceMetadata;
+ }
+
+ @XmlElement
+ public String getServiceName() {
+ return this.service == null ? "" : service.getRole();
+ }
+
+ @XmlElement
+ public String getVersion() {
+ return this.service == null ? "" : this.service.getVersion() == null ? ""
: this.service.getVersion().toString();
+ }
+
+ @XmlElement(name = "shortDesc")
+ public String getShortDescription() {
+ if (serviceMetadata == null) {
+ return getServiceName().substring(0, 1).toUpperCase(Locale.ROOT) +
getServiceName().substring(1).toLowerCase(Locale.ROOT);
+ } else {
+ return serviceMetadata.getShortDesc();
+ }
+ }
+
+ @XmlElement
+ public String getDescription() {
+ if (serviceMetadata == null) {
+ return getShortDescription() + (Type.API == getType() ? " REST API" :
Type.UI == getType() ? " Web User Interface" : "");
+ } else {
+ return serviceMetadata.getDescription();
+ }
+ }
+
+ @XmlElement
+ public Type getType() {
+ return serviceMetadata == null ? Type.UNKNOWN :
Type.valueOf(serviceMetadata.getType());
+ }
+
+ @XmlElement
+ public String getContext() {
+ return (serviceMetadata == null ? "/" +
getServiceName().toLowerCase(Locale.ROOT) : serviceMetadata.getContext()) + "/";
+ }
+
+ @XmlElement
+ public String getServiceUrl() {
+ String context = getContext();
+ if ("HIVE".equals(getServiceName())) {
Review comment:
Long term I hope we don't have to do this in the ServiceModel? It would be
better to have this captured in the service metadata.
----------------------------------------------------------------
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:
us...@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 394413)
Time Spent: 11h 20m (was: 11h 10m)
> Add home page to Knox
> ---------------------
>
> Key: KNOX-2226
> URL: https://issues.apache.org/jira/browse/KNOX-2226
> Project: Apache Knox
> Issue Type: New Feature
> Components: AdminUI
> Affects Versions: 1.3.0
> Reporter: Sandor Molnar
> Assignee: Sandor Molnar
> Priority: Major
> Labels: UI
> Fix For: 1.4.0
>
> Attachments: OnePager-Apache_Knox_Home_Page.pdf
>
> Time Spent: 11h 20m
> Remaining Estimate: 0h
>
> The lack of a home or landing page for Knox leaves users without a well-known
> place to discover the URLs for the various UIs and APIs that are being
> exposed for access by the gateway.
> This results in the need for QuickLinks in management applications like
> Ambari and Cloudera Manager to be rewritten to express the proxied URLs. This
> also results in the need for users to have to continue to go to these
> management applications for end-user URLs which is often not even appropriate.
> This proposal is for adding a Home page to Apache Knox which will present the
> various URLs in ways that are intuitive for being able to consume the proxied
> resources.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
