fr.bmartel.protocol.google.oauth.device.OauthForDeviceResponse.java Source code

Introduction

Here is the source code for fr.bmartel.protocol.google.oauth.device.OauthForDeviceResponse.java

Source

/**
 * The MIT License (MIT)
 * 
 * Copyright (c) 2015 Bertrand Martel
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package fr.bmartel.protocol.google.oauth.device;

import org.json.simple.JSONObject;

import fr.bmartel.protocol.google.constants.OauthGoogleConstants;
import fr.bmartel.utils.CommonUtils;

/**
 * This features decoder for Google Oauth2.0 for device response
 * 
 * @author Bertrand Martel
 *
 */
public class OauthForDeviceResponse {

    /**
     * device code is used to obtain access token and refresh token
     */
    private String deviceCode = "";

    /**
     * use code is the code the user have to enter at the url specified by
     * verification url
     */
    private String userCode = "";

    /**
     * url where the user has to enter the userCOde
     */
    private String verificationUrl = "";

    /**
     * expiring before value used to obtain access token and refresh token
     */
    private int expiringBefore = -1;

    /**
     * interval used to obtain access token and refresh token
     */
    private int interval = 0;

    /**
     * Build Oauth2.0 device response
     * 
     * @param deviceCode
     * @param userCode
     * @param url
     * @param expiring
     * @param interval
     */
    public OauthForDeviceResponse(String deviceCode, String userCode, String url, int expiring, int interval) {
        this.setDeviceCode(deviceCode);
        this.setUserCode(userCode);
        this.setVerificationUrl(url);
        this.setExpiringBefore(expiring);
        this.setInterval(interval);
    }

    /**
     * convert json object api response to oaut device response java object
     * 
     * @param response
     * @return
     */
    public static OauthForDeviceResponse decodeOauthForDeviceResponse(JSONObject response) {
        if (response != null) {
            if (response.containsKey(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_DEVICE_CODE)
                    && response.containsKey(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_USER_CODE)
                    && response.containsKey(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_VERIFICATION_URL)
                    && response.containsKey(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_EXPIRING)
                    && CommonUtils
                            .isInteger(response.get(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_EXPIRING).toString())
                    && response.containsKey(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_INTERVAL)
                    && CommonUtils.isInteger(
                            response.get(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_INTERVAL).toString())) {

                // build oauth device response
                return new OauthForDeviceResponse(
                        response.get(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_DEVICE_CODE).toString(),
                        response.get(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_USER_CODE).toString(),
                        response.get(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_VERIFICATION_URL).toString(),
                        Integer.parseInt(
                                response.get(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_EXPIRING).toString()),
                        Integer.parseInt(
                                response.get(OauthGoogleConstants.OAUTH_DEVICE_RESPONSE_INTERVAL).toString()));
            }
        }
        return null;
    }

    public String getDeviceCode() {
        return deviceCode;
    }

    public void setDeviceCode(String deviceCode) {
        this.deviceCode = deviceCode;
    }

    public String getUserCode() {
        return userCode;
    }

    public void setUserCode(String userCode) {
        this.userCode = userCode;
    }

    public String getVerificationUrl() {
        return verificationUrl;
    }

    public void setVerificationUrl(String verificationUrl) {
        this.verificationUrl = verificationUrl;
    }

    public int getExpiringBefore() {
        return expiringBefore;
    }

    public void setExpiringBefore(int expiringBefore) {
        this.expiringBefore = expiringBefore;
    }

    public int getInterval() {
        return interval;
    }

    public void setInterval(int interval) {
        this.interval = interval;
    }

}