Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/services/ServerInfoService.java @ 9801:1d7a72a50183 3.2.x tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Assume Compose V2, consistently
author Tom Gottfried <tom@intevation.de>
date Thu, 23 Nov 2023 10:14:13 +0100
parents 0a5239a1e46e
children
rev   line source
8858
a805211690f7 Fix license headers.
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
a805211690f7 Fix license headers.
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
2 * Software engineering by Intevation GmbH
a805211690f7 Fix license headers.
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
3 *
a805211690f7 Fix license headers.
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
a805211690f7 Fix license headers.
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
a805211690f7 Fix license headers.
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
6 * documentation coming with Dive4Elements River for details.
a805211690f7 Fix license headers.
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
7 */
a805211690f7 Fix license headers.
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
8
6457
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
9 package org.dive4elements.river.artifacts.services;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
10
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
11 import javax.xml.xpath.XPathConstants;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
12
9726
0a5239a1e46e Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 8858
diff changeset
13 import org.apache.logging.log4j.Logger;
0a5239a1e46e Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 8858
diff changeset
14 import org.apache.logging.log4j.LogManager;
6457
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
15 import org.dive4elements.artifacts.CallMeta;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
16 import org.dive4elements.artifacts.GlobalContext;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
17 import org.dive4elements.artifacts.common.ArtifactNamespaceContext;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
18 import org.dive4elements.artifacts.common.utils.Config;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
19 import org.dive4elements.artifacts.common.utils.XMLUtils;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
20 import org.w3c.dom.Document;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
21 import org.w3c.dom.Element;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
22
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
23 /**
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
24 * Through this service the client can retrieve basic information about or
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
25 * configuration of the artifact server.
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
26 * Currently it only returns the help-url (wiki) to the client.
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
27 *
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
28 * @author <a href="mailto:christian.lins@intevation.de">Christian Lins</a>
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
29 */
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
30 public class ServerInfoService extends D4EService {
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
31
8202
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 6476
diff changeset
32 /** The log used in this service.*/
9726
0a5239a1e46e Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 8858
diff changeset
33 private static Logger log = LogManager.getLogger(ServerInfoService.class);
6457
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
34
8856
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8202
diff changeset
35 private static final String XPATH_HELP_URL =
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8202
diff changeset
36 "/artifact-database/help-url/text()";
6457
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
37
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
38 @Override
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
39 protected Document doProcess(Document data, GlobalContext globalContext,
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
40 CallMeta callMeta) {
8202
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 6476
diff changeset
41 log.debug("ServerInfoService.process");
6457
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
42
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
43 Document result = XMLUtils.newDocument();
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
44
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
45 XMLUtils.ElementCreator ec = new XMLUtils.ElementCreator(
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
46 result,
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
47 ArtifactNamespaceContext.NAMESPACE_URI,
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
48 ArtifactNamespaceContext.NAMESPACE_PREFIX);
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
49
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
50 Element serverInfo = ec.create("server");
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
51
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
52 String helpUrl = (String) XMLUtils.xpath(
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
53 Config.getConfig(),
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
54 XPATH_HELP_URL,
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
55 XPathConstants.STRING);
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
56
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
57 Element info = ec.create("info");
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
58 ec.addAttr(info, "key", "help-url", true);
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
59 ec.addAttr(info, "value", helpUrl, true);
6476
d30ae7275e5a Minor fix for ServerInfoService.
Christian Lins <christian.lins@intevation.de>
parents: 6457
diff changeset
60 serverInfo.appendChild(info);
6457
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
61
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
62 result.appendChild(serverInfo);
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
63
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
64 return result;
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
65 }
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
66
41152c3a532d Add ServerInfoService (currently inactive).
Christian Lins <christian.lins@intevation.de>
parents:
diff changeset
67 }
http://dive4elements.wald.intevation.org