+ * Serves the AsyncAPI 3.0 description of the MQTT binding at + * {@code {apiRoot}/asyncapi/mqtt}, as a service description of + * OGC API - Publish-Subscribe. The document is a template filled in with the + * node ID, the API root, the broker host and the format names. + *
+ * The response is YAML, or an HTML page that shows the YAML for {@code f=html} + * and for browsers. The HTML page uses the same layout and static files as + * the CS API HTML pages. + *
+ */ +class AsyncApiHandler implements IResourceHandler +{ + static final String NAME = "asyncapi"; + static final String BINDING = "mqtt"; + static final String MEDIA_TYPE = "application/asyncapi+yaml"; + static final String SHORT_YAML = "yaml"; + static final String TEMPLATE = "asyncapi-mqtt.yaml"; + static final String HTML_TEMPLATE = "asyncapi.html"; + static final int DEFAULT_MQTT_PORT = 1883; + static final String[][] MQTT_VERSIONS = {{"5", "MQTT 5"}, {"3.1.1", "MQTT 3.1.1"}}; + + final String template; + final String htmlTemplate; + final String version; + final Supplier" + escapeHtml(brokerHost(apiRoot)) + "";
+ var ws = trim(config.get().webSocketAddress);
+ if (!ws.isEmpty())
+ list += " and WebSocket at " + escapeHtml(ws) + "";
+ return list;
+ }
+
+
+ /** Server Objects: TCP, and WebSocket if the config has a WebSocket address */
+ String servers(String apiRoot)
+ {
+ var sb = new StringBuilder();
+ var tcpHost = brokerHost(apiRoot);
+ for (var v: MQTT_VERSIONS)
+ appendServer(sb, "mqtt" + v[0].replace(".", ""), tcpHost, null, "mqtt", v, "TCP");
+
+ var ws = trim(config.get().webSocketAddress);
+ if (!ws.isEmpty())
+ {
+ var protocol = "ws";
+ if (ws.startsWith("wss://"))
+ protocol = "wss";
+ ws = ws.replaceFirst("^wss?://", "");
+ var slash = ws.indexOf('/');
+ var host = slash < 0 ? ws : ws.substring(0, slash);
+ var path = slash < 0 ? null : ws.substring(slash);
+ for (var v: MQTT_VERSIONS)
+ appendServer(sb, "mqtt" + v[0].replace(".", "") + "-" + protocol, host, path, protocol, v, protocol.equals("wss") ? "secure WebSocket" : "WebSocket");
+ }
+ return sb.toString();
+ }
+
+
+ static void appendServer(StringBuilder sb, String name, String host, String path, String protocol, String[] mqttVersion, String transport)
+ {
+ sb.append(" ").append(name).append(":\n")
+ .append(" host: '").append(host.replace("'", "''")).append("'\n");
+ if (path != null)
+ sb.append(" pathname: '").append(path.replace("'", "''")).append("'\n");
+ sb.append(" protocol: ").append(protocol).append('\n')
+ .append(" protocolVersion: '").append(mqttVersion[0]).append("'\n")
+ .append(" description: ").append(mqttVersion[1]).append(" over ").append(transport).append('.');
+ if ("5".equals(mqttVersion[0]))
+ sb.append(" Rejections carry a reason code and reason string.");
+ sb.append('\n');
+ }
+
+
+ static String trim(String s)
+ {
+ return s != null ? s.trim() : "";
+ }
+
+
+ static String escapeHtml(String s)
+ {
+ return s.replace("&", "&").replace("<", "<").replace(">", ">").replace("\"", """);
+ }
+
+
+ @Override
+ public void doPost(RequestContext ctx) throws InvalidRequestException
+ {
+ throw ServiceErrors.unsupportedOperation("Read-only resource");
+ }
+
+
+ @Override
+ public void doPut(RequestContext ctx) throws InvalidRequestException
+ {
+ throw ServiceErrors.unsupportedOperation("Read-only resource");
+ }
+
+
+ @Override
+ public void doDelete(RequestContext ctx) throws InvalidRequestException
+ {
+ throw ServiceErrors.unsupportedOperation("Read-only resource");
+ }
+
+
+ @Override
+ public void addSubResource(IResourceHandler resource)
+ {
+ throw new UnsupportedOperationException();
+ }
+
+
+ @Override
+ public void addSubResource(IResourceHandler resource, String... names)
+ {
+ throw new UnsupportedOperationException();
+ }
+}
diff --git a/services/sensorhub-service-csapi-mqtt/src/main/java/org/sensorhub/impl/service/csapi/mqtt/CsApiMqttService.java b/services/sensorhub-service-csapi-mqtt/src/main/java/org/sensorhub/impl/service/csapi/mqtt/CsApiMqttService.java
index 57b494351..f104b744b 100644
--- a/services/sensorhub-service-csapi-mqtt/src/main/java/org/sensorhub/impl/service/csapi/mqtt/CsApiMqttService.java
+++ b/services/sensorhub-service-csapi-mqtt/src/main/java/org/sensorhub/impl/service/csapi/mqtt/CsApiMqttService.java
@@ -33,7 +33,7 @@
*/
public class CsApiMqttService extends AbstractMqttServiceModuleAsyncAPI 3.0 description of the MQTT binding of this API. Clients and tools use the
+ YAML document (application/asyncapi+yaml).
MQTT 5 and MQTT 3.1.1 over ${brokerList}. Topics start with ${nodeId}/.
${doc}host.example:1883."));
+ assertTrue(html.contains("asyncapi: 3.0.0"));
+ assertEquals("a <b> & "c"", AsyncApiHandler.escapeHtml("a & \"c\""));
+
+ // WebSocket address, no viewer
+ config.webSocketAddress = "broker.example:8083/mqtt";
+ config.asyncApiViewerUrl = null;
+ html = handler.renderHtml(mapper, API_ROOT, handler.render(mapper, API_ROOT));
+ assertTrue(html.contains("data-viewer-url=\"\""));
+ assertFalse(html.contains("unpkg"));
+ assertTrue(html.contains("and WebSocket at broker.example:8083/mqtt."));
+ }
+
+
+ @Test
+ public void testFormatSelection() throws Exception
+ {
+ assertTrue(AsyncApiHandler.isHtml(null, true));
+ assertFalse(AsyncApiHandler.isHtml(null, false));
+ assertTrue(AsyncApiHandler.isHtml("html", false));
+ assertTrue(AsyncApiHandler.isHtml("text/html", false));
+ assertFalse(AsyncApiHandler.isHtml("yaml", true));
+ assertFalse(AsyncApiHandler.isHtml("application/asyncapi+yaml", true));
+ assertThrows(Exception.class, () -> AsyncApiHandler.isHtml("json", false));
+ }
+
+
+ static int count(String s, String part)
+ {
+ return s.split(java.util.regex.Pattern.quote(part), -1).length - 1;
+ }
+}