io.scanbot.shoeboxed

Class AuthHandler

java.lang.Object

io.scanbot.shoeboxed.AuthHandler

public class AuthHandler
extends Object

Controls authorization workflow.

Use it for performing OAuth authentication on Shoeboxed service. Authorization goes as follows: 1. Redirect user to authentication URL generateAuthorizationUrl(io.scanbot.shoeboxed.AuthHandler.Scope) 2. You will be redirected to ApiApplication.getRedirectUri() with appended query parameters in URL. Path this URL to getTokens(String) 3. As a result you'll receive access and refresh tokens. You can persist them and use with ShoeboxedSession

Note, that AuthHandler class keeps track of last generated URL, therefore you should not generate new one before calling getTokens(String), as it will result in AuthHandler.StateMismatchException

Thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthHandler.Scope Available OAuth scopes
static class	AuthHandler.StateMismatchException Thrown if state generated in generateAuthorizationUrl(io.scanbot.shoeboxed.AuthHandler.Scope) does not match state passed in getTokensFromAuthorizationCode(String, String) method.
static class	AuthHandler.Tokens Container for access and refresh tokens

Method Summary

Methods

Modifier and Type	Method and Description
static AuthHandler	forApplication(ApiApplication apiApplication)
String	generateAuthorizationUrl(AuthHandler.Scope scope) Generates URL for authentication.
AuthHandler.Tokens	getTokens(String url) Requests token for given URL with authentication code.
AuthHandler.Tokens	refreshTokens(String refreshToken) Request new access token for given refresh token

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forApplication

public static AuthHandler forApplication(ApiApplication apiApplication)

Returns:

instance of AuthHandler for given ApiApplication

generateAuthorizationUrl

public String generateAuthorizationUrl(AuthHandler.Scope scope)

Generates URL for authentication. Redirect user to it.

Note, that AuthHandler class keeps track of last generated URL, therefore you should not generate new one before calling getTokens(String), as it will result in AuthHandler.StateMismatchException

Parameters:

scope - AuthHandler.Scope for which to build authorization URL

Returns:

URL for authentication.

getTokens

public AuthHandler.Tokens getTokens(String url)
                             throws MalformedURLException,
                                    IOException

Requests token for given URL with authentication code.

Parameters:

url - URL to which user is redirected after authentication with generateAuthorizationUrl(io.scanbot.shoeboxed.AuthHandler.Scope)

Returns:

access and refresh tokens

Throws:

IOException - in case of communication error

MalformedURLException - if given URL is not valid or does not contain authentication parameters

refreshTokens

public AuthHandler.Tokens refreshTokens(String refreshToken)
                                 throws IOException

Request new access token for given refresh token

Returns:

access and refresh tokens

Throws:

IOException - in case of communication error