org.pac4j.oauth.client

Class DropBoxClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.client.BaseClient<C,U>

org.pac4j.core.client.IndirectClient<OAuthCredentials,U>

org.pac4j.oauth.client.BaseOAuthClient<U>

org.pac4j.oauth.client.BaseOAuth10Client<DropBoxProfile>

org.pac4j.oauth.client.DropBoxClient

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,DropBoxProfile>

public class DropBoxClient
extends BaseOAuth10Client<DropBoxProfile>

This class is the OAuth client to authenticate users in DropBox.

It returns a DropBoxProfile.

More information at https://www.dropbox.com/developers/reference/api#account-info

Since:

1.2.0

Author:

Jerome Leleu

See Also:

DropBoxProfile

Field Summary

Fields inherited from class org.pac4j.oauth.client.BaseOAuth10Client

logger, OAUTH_TOKEN, OAUTH_VERIFIER, REQUEST_TOKEN

Fields inherited from class org.pac4j.oauth.client.BaseOAuthClient

connectTimeout, key, proxyHost, proxyPort, readTimeout, secret, service, tokenAsHeader

Fields inherited from class org.pac4j.core.client.IndirectClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
DropBoxClient()
DropBoxClient(String key, String secret)

Method Summary

Modifier and Type	Method and Description
protected DropBoxProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
protected OAuthCredentials	getOAuthCredentials(WebContext context) Get the OAuth credentials from the web context.
protected String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
protected boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit(WebContext context) Internal initialization of the object.
protected DropBoxClient	newClient() Create a new instance of the client.

Methods inherited from class org.pac4j.oauth.client.BaseOAuth10Client

addAccessTokenToProfile, getAccessToken, getRequestTokenSessionAttributeName, isDirectRedirection, retrieveAuthorizationUrl

Methods inherited from class org.pac4j.oauth.client.BaseOAuthClient

clone, createProxyRequest, getClientType, getConnectTimeout, getKey, getProxyHost, getProxyPort, getReadTimeout, getSecret, getUserProfile, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, sendRequestForData, setConnectTimeout, setKey, setProxyHost, setProxyPort, setReadTimeout, setSecret, setTokenAsHeader

Methods inherited from class org.pac4j.core.client.IndirectClient

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getRedirectionUrl, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName, toString

Methods inherited from class org.pac4j.core.util.InitializableWebObject

init, reinit

Methods inherited from class java.lang.Object

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

Constructor Detail

DropBoxClient

public DropBoxClient()

DropBoxClient

public DropBoxClient(String key,
                     String secret)

Method Detail

newClient

protected DropBoxClient newClient()

Description copied from class: BaseClient

Create a new instance of the client.

Specified by:

newClient in class BaseClient<OAuthCredentials,DropBoxProfile>

Returns:

A new instance of the client

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class BaseOAuthClient<DropBoxProfile>

Parameters:

context - the web context

getProfileUrl

protected String getProfileUrl(org.scribe.model.Token accessToken)

Description copied from class: BaseOAuthClient

Retrieve the url of the profile of the authenticated user for the provider.

Specified by:

getProfileUrl in class BaseOAuthClient<DropBoxProfile>

Parameters:

accessToken - only used when constructing dynamic urls from data in the token

Returns:

the url of the user profile given by the provider

getOAuthCredentials

protected OAuthCredentials getOAuthCredentials(WebContext context)

Get the OAuth credentials from the web context.

Overrides:

getOAuthCredentials in class BaseOAuth10Client<DropBoxProfile>

Parameters:

context - the web context

Returns:

the OAuth credentials

extractUserProfile

protected DropBoxProfile extractUserProfile(String body)

Description copied from class: BaseOAuthClient

Extract the user profile from the response (JSON, XML...) of the profile url.

Specified by:

extractUserProfile in class BaseOAuthClient<DropBoxProfile>

Parameters:

body - the response body

Returns:

the user profile object

hasBeenCancelled

protected boolean hasBeenCancelled(WebContext context)

Description copied from class: BaseOAuthClient

Return if the authentication has been cancelled.

Specified by:

hasBeenCancelled in class BaseOAuthClient<DropBoxProfile>

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.