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.velux.internal.bridge.common;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16
  17 /**
  18  * Specific bridge communication message supported by the Velux bridge.
  19  * <P>
  20  * Message semantic: Communication to authenticate itself, resulting in a return of current bridge state.
  21  * <P>
  22  * In addition to the common methods defined by {@link BridgeCommunicationProtocol}
  23  * each protocol-specific implementation has to provide the following methods:
  24  * <UL>
  25  * <LI>{@link #setPassword} for defining the intended authentication value.
  26  * </UL>
  27  *
  28  * @see BridgeCommunicationProtocol
  29  *
  30  * @author Guenther Schreiner - Initial contribution.
  31  */
  32 @NonNullByDefault
  33 public abstract class Login implements BridgeCommunicationProtocol {
  34
  35     /**
  36      * Sets the intended password string to be used for authentication
  37      *
  38      * @param thisPassword Password passed as String.
  39      */
  40     public void setPassword(String thisPassword) {
  41     }
  42
  43     /**
  44      * Returns the authentication information optionally to be used for later following
  45      * messages.
  46      *
  47      * @return <b>authentication token</b> as String which can be used for next operations.
  48      */
  49     public String getAuthToken() {
  50         return "";
  51     }
  52 }