OAuthCredentials.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.binding.netatmo.internal.authentication;

import org.openhab.binding.netatmo.internal.NetatmoException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This internal class holds the different crendentials necessary for the
 * OAuth2 flow to work. It also provides basic methods to refresh the access
 * token.
 *
 * @author Thomas.Eichstaedt-Engelen
 * @author Ing. Peter Weiss
 * @since 1.6.0
 */

public class OAuthCredentials {

    private static final Logger logger = LoggerFactory.getLogger(OAuthCredentials.class);

    /**
     * The client id to access the Netatmo API. Normally set in
     * <code>openhab.cfg</code>.
     * 
     * @see <a
     *      href="http://dev.netatmo.com/doc/authentication/usercred">Client
     *      Credentials</a>
     */
    private String clientId;

    /**
     * The client secret to access the Netatmo API. Normally set in
     * <code>openhab.cfg</code>.
     * 
     * @see <a
     *      href="http://dev.netatmo.com/doc/authentication/usercred">Client
     *      Credentials</a>
     */
    private String clientSecret;

    /**
     * The refresh token to access the Netatmo API. Normally set in
     * <code>openhab.cfg</code>.
     * 
     * @see <a
     *      href="http://dev.netatmo.com/doc/authentication/usercred">Client Credentials</a>
     * @see <a
     *      href="http://dev.netatmo.com/doc/authentication/refreshtoken">Refresh Token</a>
     */
    private String refreshToken;

    /**
     * The access token to access the Netatmo API. Automatically renewed
     * from the API using the refresh token.
     * 
     * @see <a
     *      href="http://dev.netatmo.com/doc/authentication/refreshtoken">Refresh
     *      Token</a>
     * @see #refreshAccessToken()
     */
    private String accessToken;

    /**
     * Indicates if there are weather items for this binding
     */
    private boolean weather;

    /**
     * Indicates if there are weather items for this binding
     */
    private boolean camera;

    public String getAccessToken() {
        return accessToken;
    }

    public void setAccessToken(String accessToken) {
        this.accessToken = accessToken;
    }

    public String getClientId() {
        return clientId;
    }

    public void setClientId(String clientId) {
        this.clientId = clientId;
    }

    public String getClientSecret() {
        return clientSecret;
    }

    public void setClientSecret(String clientSecret) {
        this.clientSecret = clientSecret;
    }

    public String getRefreshToken() {
        return refreshToken;
    }

    public void setRefreshToken(String refreshToken) {
        this.refreshToken = refreshToken;
    }

    public boolean getWeather() {
		return weather;
	}

	public void setWeather(boolean weather) {
		this.weather = weather;
	}

	public boolean getCamera() {
		return camera;
	}

	public void setCamera(boolean camera) {
		this.camera = camera;
	}

	public boolean noAccessToken() {
        return this.accessToken == null;
    }

    public void refreshAccessToken() {
        logger.debug("Refreshing access token.");

        if (this.getWeather() == false && this.getCamera() == false) {
            logger.debug("There are not any items configured for this binding!");
            return;
        }

        final RefreshTokenRequest request = new RefreshTokenRequest(this.getClientId(), this.getClientSecret(),
                this.getRefreshToken(), this.getWeather(), this.getCamera());
        logger.debug("Request: {}", request);

        final RefreshTokenResponse response = request.execute();
        logger.debug("Response: {}", response);

        if (response == null) {
            throw new NetatmoException("Could not refresh access token! If you see "
                    + "'Fatal transport error: javax.net.ssl.SSLHandshakeException' "
                    + "above. You need to install the StartCom CA certificate and restart openHAB. "
                    + "See https://github.com/openhab/openhab/wiki/Netatmo-Binding#missing-certificate-authority "
                    + "for more information.");
        }

        this.accessToken = response.getAccessToken();

    }

}