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.boschindego.internal;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.openhab.binding.boschindego.internal.exceptions.IndegoException;
  17
  18 /**
  19  * The {@link AuthorizationProvider} is responsible for providing
  20  * authorization headers needed for communicating with the Bosch Indego
  21  * cloud services.
  22  *
  23  * @author Jacob Laursen - Initial contribution
  24  */
  25 @NonNullByDefault
  26 public interface AuthorizationProvider {
  27     /**
  28      * Get HTTP authorization header for authenticating with Bosch Indego services.
  29      *
  30      * @return the header contents
  31      * @throws IndegoException if not authorized
  32      */
  33     String getAuthorizationHeader() throws IndegoException;
  34 }