discoveryResults = inbox.stream()
+ .filter(discoveryResult -> willConnectVia(discoveryResult, bridge)).collect(Collectors.toList());
+
+ return templateGenerator.createBridgeAndThingConfigurationTemplate(bridge, pairedThings, discoveryResults);
+ }
+
+ private boolean isConnectedVia(Thing thing, Bridge bridge) {
+ return bridge.getUID().equals(thing.getBridgeUID());
+ }
+
+ private boolean willConnectVia(DiscoveryResult discoveryResult, Bridge bridge) {
+ return bridge.getUID().equals(discoveryResult.getBridgeUID());
+ }
+
+ private boolean isMieleCloudBridge(Thing thing) {
+ return MieleCloudBindingConstants.THING_TYPE_BRIDGE.equals(thing.getThingTypeUID());
+ }
+
+ private String renderSslWarning(HttpServletRequest request, String skeleton) {
+ if (!request.isSecure()) {
+ return skeleton.replace(NO_SSL_WARNING_PLACEHOLDER, "\n"
+ + " Warning: We strongly advice to proceed only with SSL enabled for a secure data exchange.\n"
+ + " See
Securing access to openHAB for details.\n"
+ + "
Missing client ID.
");
+ } else if (ServletUtil.isParameterEnabled(request, MISSING_CLIENT_SECRET_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+
+ "Missing client secret.
");
+ } else if (ServletUtil.isParameterEnabled(request, MISSING_BRIDGE_ID_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+ "Missing bridge ID.
");
+ } else if (ServletUtil.isParameterEnabled(request, MISSING_EMAIL_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+ "Missing e-mail address.
");
+ } else if (ServletUtil.isParameterEnabled(request, MALFORMED_BRIDGE_ID_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+ "Malformed bridge ID. A bridge ID may only contain letters, numbers, '-' and '_'!
");
+ } else if (ServletUtil.isParameterEnabled(request, MALFORMED_EMAIL_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+ "Malformed e-mail address.
");
+ } else if (ServletUtil.isParameterEnabled(request, FAILED_TO_DERIVE_REDIRECT_URL_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+ "Failed to derive redirect URL.
");
+ } else if (ServletUtil.isParameterPresent(request,
+ ONGOING_AUTHORIZATION_IN_STEP1_EXPIRES_IN_MINUTES_PARAMETER_NAME)) {
+ String minutesUntilExpiry = request
+ .getParameter(ONGOING_AUTHORIZATION_IN_STEP1_EXPIRES_IN_MINUTES_PARAMETER_NAME);
+ if (ONGOING_AUTHORIZATION_UNKNOWN_EXPIRY_TIME.equals(minutesUntilExpiry)) {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+ "There is an authorization ongoing at the moment. Please complete that authorization prior to starting a new one or try again later.
");
+ } else {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+ "There is an authorization ongoing at the moment. Please complete that authorization prior to starting a new one or try again in "
+ + minutesUntilExpiry + " minutes.
");
+ }
+ } else if (ServletUtil.isParameterEnabled(request, NO_ONGOING_AUTHORIZATION_IN_STEP2_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+ "Failed to start auhtorization process. Are you trying to perform multiple authorizations at the same time?
");
+ } else if (ServletUtil.isParameterEnabled(request, MISSING_REQUEST_URL_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER,
+ "Missing request URL. Please try again.
");
+ } else {
+ return skeleton.replace(ERROR_MESSAGE_PLACEHOLDER, "");
+ }
+ }
+}
diff --git a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/ResourceLoader.java b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/ResourceLoader.java
new file mode 100644
index 0000000000000..d93a3c9999f19
--- /dev/null
+++ b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/ResourceLoader.java
@@ -0,0 +1,86 @@
+/**
+ * Copyright (c) 2010-2021 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.mielecloud.internal.config.servlet;
+
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.charset.StandardCharsets;
+import java.util.Scanner;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.osgi.framework.BundleContext;
+
+/**
+ * Provides access to resource files for servlets.
+ *
+ * @author Björn Lange - Initial Contribution
+ */
+@NonNullByDefault
+public final class ResourceLoader {
+ private static final String BEGINNING_OF_INPUT = "\\A";
+
+ private final String basePath;
+ private final BundleContext bundleContext;
+
+ /**
+ * Creates a new {@link ResourceLoader}.
+ *
+ * @param basePath The base path to use for loading. A trailing {@code "/"} is removed.
+ * @param bundleContext {@link BundleContext} to load from.
+ */
+ public ResourceLoader(String basePath, BundleContext bundleContext) {
+ this.basePath = removeTrailingSlashes(basePath);
+ this.bundleContext = bundleContext;
+ }
+
+ private String removeTrailingSlashes(String value) {
+ String ret = value;
+ while (ret.endsWith("/")) {
+ ret = ret.substring(0, ret.length() - 1);
+ }
+ return ret;
+ }
+
+ /**
+ * Opens a resource relative to the base path.
+ *
+ * @param filename The filename of the resource to load.
+ * @return A stream reading from the resource file.
+ * @throws FileNotFoundException If the requested resource file cannot be found.
+ * @throws IOException If an error occurs while opening a stream to the resource.
+ */
+ public InputStream openResource(String filename) throws IOException {
+ URL url = bundleContext.getBundle().getEntry(basePath + "/" + filename);
+ if (url == null) {
+ throw new FileNotFoundException("Cannot find '" + filename + "' relative to '" + basePath + "'");
+ }
+
+ return url.openStream();
+ }
+
+ /**
+ * Loads the contents of a resource file as UTF-8 encoded {@link String}.
+ *
+ * @param filename The filename of the resource to load.
+ * @return The contents of the file.
+ * @throws FileNotFoundException If the requested resource file cannot be found.
+ * @throws IOException If an error occurs while opening a stream to the resource or reading from it.
+ */
+ public String loadResourceAsString(String filename) throws IOException {
+ try (Scanner scanner = new Scanner(openResource(filename), StandardCharsets.UTF_8.name())) {
+ return scanner.useDelimiter(BEGINNING_OF_INPUT).next();
+ }
+ }
+}
diff --git a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/ResultServlet.java b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/ResultServlet.java
new file mode 100644
index 0000000000000..5a5db09090967
--- /dev/null
+++ b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/ResultServlet.java
@@ -0,0 +1,96 @@
+/**
+ * Copyright (c) 2010-2021 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.mielecloud.internal.config.servlet;
+
+import javax.servlet.http.HttpServletRequest;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.binding.mielecloud.internal.auth.OAuthException;
+import org.openhab.binding.mielecloud.internal.config.OAuthAuthorizationHandler;
+import org.openhab.binding.mielecloud.internal.config.exception.NoOngoingAuthorizationException;
+import org.openhab.core.thing.ThingUID;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Servlet processing the response by the Miele service after a login. This servlet is called as a result of a
+ * completed login to the Miele service and assumes that the OAuth 2 parameters are passed. Depending on the parameters
+ * and whether the token response can be fetched either the browser is redirected to the success or the failure page.
+ *
+ * @author Björn Lange - Initial Contribution
+ */
+@NonNullByDefault
+public final class ResultServlet extends AbstractRedirectionServlet {
+ private static final long serialVersionUID = 2157912755568949550L;
+
+ public static final String CODE_PARAMETER_NAME = "code";
+ public static final String STATE_PARAMETER_NAME = "state";
+ public static final String ERROR_PARAMETER_NAME = "error";
+
+ private final Logger logger = LoggerFactory.getLogger(ResultServlet.class);
+
+ private final OAuthAuthorizationHandler authorizationHandler;
+
+ /**
+ * Creates a new {@link ResultServlet}.
+ *
+ * @param authorizationHandler Handler implementing the OAuth authorization.
+ */
+ public ResultServlet(OAuthAuthorizationHandler authorizationHandler) {
+ this.authorizationHandler = authorizationHandler;
+ }
+
+ @Override
+ protected String getRedirectionDestination(HttpServletRequest request) {
+ String error = request.getParameter(ERROR_PARAMETER_NAME);
+ if (error != null) {
+ logger.warn("Received error response: {}", error);
+ return "/mielecloud/failure?" + FailureServlet.OAUTH2_ERROR_PARAMETER_NAME + "=" + error;
+ }
+
+ String code = request.getParameter(CODE_PARAMETER_NAME);
+ if (code == null) {
+ logger.warn("Code is null");
+ return "/mielecloud/failure?" + FailureServlet.ILLEGAL_RESPONSE_PARAMETER_NAME + "=true";
+ }
+ String state = request.getParameter(STATE_PARAMETER_NAME);
+ if (state == null) {
+ logger.warn("State is null");
+ return "/mielecloud/failure?" + FailureServlet.ILLEGAL_RESPONSE_PARAMETER_NAME + "=true";
+ }
+
+ try {
+ ThingUID bridgeId = authorizationHandler.getBridgeUid();
+ String email = authorizationHandler.getEmail();
+
+ StringBuffer requestUrl = request.getRequestURL();
+ if (requestUrl == null) {
+ return "/mielecloud/failure?" + FailureServlet.MISSING_REQUEST_URL_PARAMETER_NAME + "=true";
+ }
+
+ try {
+ authorizationHandler.completeAuthorization(requestUrl.toString() + "?" + request.getQueryString());
+ } catch (OAuthException e) {
+ logger.warn("Failed to complete authorization.", e);
+ return "/mielecloud/failure?" + FailureServlet.FAILED_TO_COMPLETE_AUTHORIZATION_PARAMETER_NAME
+ + "=true";
+ }
+
+ return "/mielecloud/success?" + SuccessServlet.BRIDGE_UID_PARAMETER_NAME + "=" + bridgeId.getAsString()
+ + "&" + SuccessServlet.EMAIL_PARAMETER_NAME + "=" + email;
+ } catch (NoOngoingAuthorizationException e) {
+ logger.warn("Failed to complete authorization: There is no ongoing authorization or it timed out");
+ return "/mielecloud/failure?" + FailureServlet.NO_ONGOING_AUTHORIZATION_PARAMETER_NAME + "=true";
+ }
+ }
+}
diff --git a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/ServletUtil.java b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/ServletUtil.java
new file mode 100644
index 0000000000000..4441aca3d8d8a
--- /dev/null
+++ b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/ServletUtil.java
@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) 2010-2021 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.mielecloud.internal.config.servlet;
+
+import javax.servlet.http.HttpServletRequest;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * Utility class for common servlet tasks.
+ *
+ * @author Björn Lange - Initial Contribution
+ */
+@NonNullByDefault
+public final class ServletUtil {
+ private ServletUtil() {
+ throw new UnsupportedOperationException();
+ }
+
+ /**
+ * Gets the value of a request parameter or returns a default if the parameter is not present.
+ */
+ public static String getParameterValueOrDefault(HttpServletRequest request, String parameterName,
+ String defaultValue) {
+ String parameterValue = request.getParameter(parameterName);
+ if (parameterValue == null) {
+ return defaultValue;
+ } else {
+ return parameterValue;
+ }
+ }
+
+ /**
+ * Checks whether a request parameter is enabled.
+ */
+ public static boolean isParameterEnabled(HttpServletRequest request, String parameterName) {
+ return "true".equalsIgnoreCase(getParameterValueOrDefault(request, parameterName, "false"));
+ }
+
+ /**
+ * Checks whether a parameter is present in a request.
+ */
+ public static boolean isParameterPresent(HttpServletRequest request, String parameterName) {
+ String parameterValue = request.getParameter(parameterName);
+ return parameterValue != null && !parameterValue.trim().isEmpty();
+ }
+}
diff --git a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/SuccessServlet.java b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/SuccessServlet.java
new file mode 100644
index 0000000000000..d240f215ee738
--- /dev/null
+++ b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/servlet/SuccessServlet.java
@@ -0,0 +1,212 @@
+/**
+ * Copyright (c) 2010-2021 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.mielecloud.internal.config.servlet;
+
+import java.io.IOException;
+import java.util.Locale;
+import java.util.Optional;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.binding.mielecloud.internal.config.ThingsTemplateGenerator;
+import org.openhab.binding.mielecloud.internal.util.EmailValidator;
+import org.openhab.binding.mielecloud.internal.webservice.language.LanguageProvider;
+import org.openhab.core.thing.ThingUID;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Servlet showing the success page.
+ *
+ * @author Björn Lange - Initial Contribution
+ */
+@NonNullByDefault
+public class SuccessServlet extends AbstractShowPageServlet {
+ private static final long serialVersionUID = 7013060161686096950L;
+
+ public static final String BRIDGE_UID_PARAMETER_NAME = "bridgeUid";
+ public static final String EMAIL_PARAMETER_NAME = "email";
+
+ public static final String BRIDGE_CREATION_FAILED_PARAMETER_NAME = "bridgeCreationFailed";
+ public static final String BRIDGE_RECONFIGURATION_FAILED_PARAMETER_NAME = "bridgeReconfigurationFailed";
+
+ private static final String ERROR_MESSAGE_TEXT_PLACEHOLDER = "";
+ private static final String BRIDGE_UID_PLACEHOLDER = "";
+ private static final String EMAIL_PLACEHOLDER = "";
+ private static final String THINGS_TEMPLATE_CODE_PLACEHOLDER = "";
+
+ private static final String LOCALE_OPTIONS_PLACEHOLDER = "";
+
+ private static final String DEFAULT_LANGUAGE = "en";
+ private static final Set SUPPORTED_LANGUAGES = Set.of("da", "nl", "en", "fr", "de", "it", "nb", "es");
+
+ private final Logger logger = LoggerFactory.getLogger(SuccessServlet.class);
+
+ private final LanguageProvider languageProvider;
+ private final ThingsTemplateGenerator templateGenerator;
+
+ /**
+ * Creates a new {@link SuccessServlet}.
+ *
+ * @param resourceLoader Loader for resources.
+ * @param languageProvider Provider for the language to use as default selection.
+ */
+ public SuccessServlet(ResourceLoader resourceLoader, LanguageProvider languageProvider) {
+ super(resourceLoader);
+ this.languageProvider = languageProvider;
+ this.templateGenerator = new ThingsTemplateGenerator();
+ }
+
+ @Override
+ protected String handleGetRequest(HttpServletRequest request, HttpServletResponse response)
+ throws MieleHttpException, IOException {
+ String bridgeUidString = request.getParameter(BRIDGE_UID_PARAMETER_NAME);
+ if (bridgeUidString == null || bridgeUidString.isEmpty()) {
+ logger.warn("Success page is missing bridge UID.");
+ return getResourceLoader().loadResourceAsString("failure.html").replace(ERROR_MESSAGE_TEXT_PLACEHOLDER,
+ "Missing bridge UID.");
+ }
+
+ String email = request.getParameter(EMAIL_PARAMETER_NAME);
+ if (email == null || email.isEmpty()) {
+ logger.warn("Success page is missing e-mail address.");
+ return getResourceLoader().loadResourceAsString("failure.html").replace(ERROR_MESSAGE_TEXT_PLACEHOLDER,
+ "Missing e-mail address.");
+ }
+
+ ThingUID bridgeUid = null;
+ try {
+ bridgeUid = new ThingUID(bridgeUidString);
+ } catch (IllegalArgumentException e) {
+ logger.warn("Success page received malformed bridge UID '{}'.", bridgeUidString);
+ return getResourceLoader().loadResourceAsString("failure.html").replace(ERROR_MESSAGE_TEXT_PLACEHOLDER,
+ "Malformed bridge UID.");
+ }
+
+ if (!EmailValidator.isValid(email)) {
+ logger.warn("Success page received malformed e-mail address '{}'.", email);
+ return getResourceLoader().loadResourceAsString("failure.html").replace(ERROR_MESSAGE_TEXT_PLACEHOLDER,
+ "Malformed e-mail address.");
+ }
+
+ String skeleton = getResourceLoader().loadResourceAsString("success.html");
+ skeleton = renderErrorMessage(request, skeleton);
+ skeleton = renderBridgeUid(skeleton, bridgeUid);
+ skeleton = renderEmail(skeleton, email);
+ skeleton = renderLocaleSelection(skeleton);
+ skeleton = renderBridgeConfigurationTemplate(skeleton, bridgeUid, email);
+ return skeleton;
+ }
+
+ private String renderErrorMessage(HttpServletRequest request, String skeleton) {
+ if (ServletUtil.isParameterEnabled(request, BRIDGE_CREATION_FAILED_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_TEXT_PLACEHOLDER,
+ "Could not auto configure the bridge. Failed to approve the bridge from the inbox. Please try the configuration flow again.
");
+ } else if (ServletUtil.isParameterEnabled(request, BRIDGE_RECONFIGURATION_FAILED_PARAMETER_NAME)) {
+ return skeleton.replace(ERROR_MESSAGE_TEXT_PLACEHOLDER,
+ "Could not auto reconfigure the bridge. Bridge thing or thing handler is not available. Please try the configuration flow again.
");
+ } else {
+ return skeleton.replace(ERROR_MESSAGE_TEXT_PLACEHOLDER, "");
+ }
+ }
+
+ private String renderBridgeUid(String skeleton, ThingUID bridgeUid) {
+ return skeleton.replace(BRIDGE_UID_PLACEHOLDER, bridgeUid.getAsString());
+ }
+
+ private String renderEmail(String skeleton, String email) {
+ return skeleton.replace(EMAIL_PLACEHOLDER, email);
+ }
+
+ private String renderLocaleSelection(String skeleton) {
+ String preSelectedLanguage = languageProvider.getLanguage().filter(SUPPORTED_LANGUAGES::contains)
+ .orElse(DEFAULT_LANGUAGE);
+
+ return skeleton.replace(LOCALE_OPTIONS_PLACEHOLDER,
+ SUPPORTED_LANGUAGES.stream().map(Language::fromCode).filter(Optional::isPresent).map(Optional::get)
+ .sorted()
+ .map(language -> createOptionTag(language, preSelectedLanguage.equals(language.getCode())))
+ .collect(Collectors.joining("\n")));
+ }
+
+ private String createOptionTag(Language language, boolean selected) {
+ String firstPart = "