git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.mielecloud.internal.webservice;
  14
  15 import java.util.concurrent.ScheduledExecutorService;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.openhab.binding.mielecloud.internal.auth.OAuthTokenRefresher;
  20 import org.openhab.binding.mielecloud.internal.webservice.language.LanguageProvider;
  21 import org.openhab.core.io.net.http.HttpClientFactory;
  22
  23 /**
  24  * Represents a webservice configuration.
  25  *
  26  * @author Björn Lange - Initial contribution
  27  */
  28 @NonNullByDefault
  29 public final class MieleWebserviceConfiguration {
  30     private final HttpClientFactory httpClientFactory;
  31     private final LanguageProvider languageProvider;
  32     private final OAuthTokenRefresher tokenRefresher;
  33     private final String serviceHandle;
  34     private final ScheduledExecutorService scheduler;
  35
  36     private MieleWebserviceConfiguration(MieleWebserviceConfigurationBuilder builder) {
  37         this.httpClientFactory = getOrThrow(builder.httpClientFactory, "httpClientFactory");
  38         this.languageProvider = getOrThrow(builder.languageProvider, "languageProvider");
  39         this.tokenRefresher = getOrThrow(builder.tokenRefresher, "tokenRefresher");
  40         this.serviceHandle = getOrThrow(builder.serviceHandle, "serviceHandle");
  41         this.scheduler = getOrThrow(builder.scheduler, "scheduler");
  42     }
  43
  44     private static <T> T getOrThrow(@Nullable T object, String objectName) {
  45         if (object == null) {
  46             throw new IllegalArgumentException(objectName + " must not be null");
  47         }
  48         return object;
  49     }
  50
  51     /**
  52      * Gets the factory to use for HttpClient construction.
  53      */
  54     public HttpClientFactory getHttpClientFactory() {
  55         return httpClientFactory;
  56     }
  57
  58     /**
  59      * Gets the provider for the language to use when making requests to the API.
  60      */
  61     public LanguageProvider getLanguageProvider() {
  62         return languageProvider;
  63     }
  64
  65     /**
  66      * Gets the refresher for OAuth tokens.
  67      */
  68     public OAuthTokenRefresher getTokenRefresher() {
  69         return tokenRefresher;
  70     }
  71
  72     /**
  73      * Gets the handle referring to the OAuth tokens in the framework's persistent storage.
  74      */
  75     public String getServiceHandle() {
  76         return serviceHandle;
  77     }
  78
  79     /**
  80      * Gets the system wide scheduler.
  81      */
  82     public ScheduledExecutorService getScheduler() {
  83         return scheduler;
  84     }
  85
  86     public static MieleWebserviceConfigurationBuilder builder() {
  87         return new MieleWebserviceConfigurationBuilder();
  88     }
  89
  90     public static final class MieleWebserviceConfigurationBuilder {
  91         @Nullable
  92         private HttpClientFactory httpClientFactory;
  93         @Nullable
  94         private LanguageProvider languageProvider;
  95         @Nullable
  96         private OAuthTokenRefresher tokenRefresher;
  97         @Nullable
  98         private String serviceHandle;
  99         @Nullable
 100         private ScheduledExecutorService scheduler;
 101
 102         private MieleWebserviceConfigurationBuilder() {
 103         }
 104
 105         public MieleWebserviceConfigurationBuilder withHttpClientFactory(HttpClientFactory httpClientFactory) {
 106             this.httpClientFactory = httpClientFactory;
 107             return this;
 108         }
 109
 110         public MieleWebserviceConfigurationBuilder withLanguageProvider(LanguageProvider languageProvider) {
 111             this.languageProvider = languageProvider;
 112             return this;
 113         }
 114
 115         public MieleWebserviceConfigurationBuilder withTokenRefresher(OAuthTokenRefresher tokenRefresher) {
 116             this.tokenRefresher = tokenRefresher;
 117             return this;
 118         }
 119
 120         public MieleWebserviceConfigurationBuilder withServiceHandle(String serviceHandle) {
 121             this.serviceHandle = serviceHandle;
 122             return this;
 123         }
 124
 125         public MieleWebserviceConfigurationBuilder withScheduler(ScheduledExecutorService scheduler) {
 126             this.scheduler = scheduler;
 127             return this;
 128         }
 129
 130         public MieleWebserviceConfiguration build() {
 131             return new MieleWebserviceConfiguration(this);
 132         }
 133     }
 134 }