com.smartsheet.api.oauth.OAuthFlow Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation
Library for connecting to Smartsheet Services
There is a newer version: 3.2.0
package com.smartsheet.api.oauth;

/*
 * #[license]
 * Smartsheet SDK for Java
 * %%
 * Copyright (C) 2014 Smartsheet
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * %[license]
 */


import com.smartsheet.api.InvalidRequestException;
import com.smartsheet.api.internal.http.HttpClientException;
import com.smartsheet.api.internal.json.JSONSerializerException;

import java.net.URISyntaxException;
import java.util.EnumSet;

/**
 * OAuthFlow interface provides methods to do the OAuth2 authorization.
 * 
 * Thread Safety: Implementation of this interface must be thread safe.
 */
public interface OAuthFlow {
	
	/**
	 * Generate a new authorization URL.
	 *
	 * @param scopes the requested scopes
	 * @param state an arbitrary string that will be returned to your app; intended to be used by you to ensure that 
	 * this redirect is indeed from an OAuth flow that you initiated.
	 * @return the authorization URL
	 * @throws IllegalArgumentException if scopes is null or empty
	 */
	public String newAuthorizationURL(EnumSet scopes, String state);

	/**
	 * Extract AuthorizationResult from the authorization response URL (i.e. the redirectURL with the response
	 * parameters from Smartsheet OAuth server).
	 *
	 * @param authorizationResponseURL the authorization response url
	 * @return the authorization result
	 * @throws URISyntaxException the URI syntax exception
	 * @throws AccessDeniedException the access denied exception
	 * @throws UnsupportedResponseTypeException the unsupported response type exception
	 * @throws InvalidScopeException the invalid scope exception
	 * @throws OAuthAuthorizationCodeException the o auth authorization code exception
	 * @throws IllegalArgumentException if any other error occurred during the operation
	 */
	public AuthorizationResult extractAuthorizationResult(String authorizationResponseURL) throws 
		URISyntaxException, AccessDeniedException, UnsupportedResponseTypeException, InvalidScopeException, 
		OAuthAuthorizationCodeException;

	/**
	 * Obtain a new token using AuthorizationResult.
	 *
	 * @param authorizationResult the authorization result
	 * @return the token
	 * @throws OAuthTokenException the o auth token exception
	 * @throws JSONSerializerException the JSON serializer exception
	 * @throws HttpClientException the http client exception
	 * @throws URISyntaxException the URI syntax exception
	 * @throws InvalidRequestException the invalid request exception
	 * @throws IllegalArgumentException if any other error occurred during the operation
	 */
	public Token obtainNewToken(AuthorizationResult authorizationResult) throws OAuthTokenException, JSONSerializerException, HttpClientException, URISyntaxException, InvalidRequestException;

	/**
	 * Refresh token.
	 *
	 * @param token the token to refresh
	 * @return the refreshed token
	 * @throws OAuthTokenException the o auth token exception
	 * @throws JSONSerializerException the JSON serializer exception
	 * @throws HttpClientException the http client exception
	 * @throws URISyntaxException the URI syntax exception
	 * @throws InvalidRequestException the invalid request exception
	 * @throws IllegalArgumentException if any other error occurred during the operation
	 */
	public Token refreshToken(Token token) throws OAuthTokenException, JSONSerializerException, HttpClientException, URISyntaxException, InvalidRequestException;

	/**
	 * Revoke access token.
	 *
	 * Exceptions:
	 *   - IllegalArgumentException : if url is null or empty
	 *   - InvalidTokenRequestException : if the token request is invalid
	 *   - InvalidOAuthClientException : if the client information is invalid
	 *   - InvalidOAuthGrantException : if the authorization code or refresh token is invalid or
	 *   expired, the redirect_uri does not match, or the hash value does not match the client secret and/or code
	 *   - UnsupportedOAuthGrantTypeException : if the grant type is invalid
	 *   - OAuthTokenException : if any other error occurred during the operation
	 *
	 * @param token the access token to revoke access from
	 * @throws OAuthTokenException the o auth token exception
	 * @throws JSONSerializerException the JSON serializer exception
	 * @throws HttpClientException the http client exception
	 * @throws URISyntaxException the URI syntax exception
	 * @throws InvalidRequestException the invalid request exception
	 */
	public void revokeAccessToken(Token token) throws OAuthTokenException, JSONSerializerException, HttpClientException,
			URISyntaxException, InvalidRequestException;
}