1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* ============LICENSE_START==========================================
* ONAP Portal SDK
* ===================================================================
* Copyright © 2017 AT&T Intellectual Property. All rights reserved.
* ===================================================================
*
* Unless otherwise specified, all software contained herein is licensed
* under the Apache License, Version 2.0 (the "License");
* you may not use this software 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.
*
* Unless otherwise specified, all documentation contained herein is licensed
* under the Creative Commons License, Attribution 4.0 Intl. (the "License");
* you may not use this documentation except in compliance with the License.
* You may obtain a copy of the License at
*
* https://creativecommons.org/licenses/by/4.0/
*
* Unless required by applicable law or agreed to in writing, documentation
* 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.
*
* ============LICENSE_END============================================
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
*/
package org.onap.portalapp.controller.core;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.jar.Attributes;
import java.util.jar.Manifest;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import org.onap.portalsdk.core.controller.RestrictedBaseController;
import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
/**
* This controller responds to a request for the web application manifest,
* returning a JSON with the information that was created at build time.
*
* Manifest entries have names with hyphens, which means Javascript code can't
* simply use the shorthand object.key; instead use object['key'].
*/
@RestController
@RequestMapping("/")
public class ManifestController extends RestrictedBaseController {
private static final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(ManifestController.class);
/** Path to resource on classpath */
private static final String MANIFEST_RESOURCE_PATH = "/META-INF/MANIFEST.MF";
/**
* Required to obtain the webapp manifest.
*/
@Autowired
private ServletContext context;
/**
* Gets the content of the webapp manifest file META-INF/MANIFEST.MF.
*
* @return Attributes object with key-value pairs from the manifest
* @throws IOException
*/
private Attributes getWebappManifest() throws IOException {
// Manifest is formatted as Java-style properties
InputStream inputStream = context.getResourceAsStream(MANIFEST_RESOURCE_PATH);
if (inputStream == null)
throw new IOException("getWebappManifest: failed to get resource at path " + MANIFEST_RESOURCE_PATH);
Manifest manifest = new Manifest(inputStream);
inputStream.close();
return manifest.getMainAttributes();
}
/**
* Gets the webapp manifest contents as a JSON object.
*
* @return A map of key-value pairs. On success:
*
* <pre>
* {
* "key1": "value1",
* "key2": "value2"
* }
* </pre>
*
* On failure:
*
* <pre>
* { "error": "message" }
* </pre>
*/
@RequestMapping(value = { "/manifest" }, method = RequestMethod.GET, produces = "application/json")
@ResponseBody
public Map<Object, Object> getManifest() {
try {
Attributes attributes = getWebappManifest();
return attributes;
} catch (Exception ex) {
logger.error(EELFLoggerDelegate.errorLogger, "getManifest failed", ex);
Map<Object, Object> response = new HashMap<>();
response.put("error", "failed to get manifest: " + ex.toString());
return response;
}
}
}
|
