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,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

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

org.pac4j.oauth.client.DropBoxClient

All Implemented Interfaces:

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

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

service

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver

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 com.github.scribejava.core.builder.api.BaseApi<com.github.scribejava.core.oauth.OAuth10aService>	getApi() Define the OAuth API for this client.
protected OAuthCredentials	getOAuthCredentials(WebContext context) Get the OAuth credentials from the web context.
protected String	getProfileUrl(com.github.scribejava.core.model.OAuth1Token token) Retrieve the url of the profile of the authenticated user for the provider.

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

addAccessTokenToProfile, getAccessToken, getRequestTokenSessionAttributeName, retrieveAuthorizationUrl, signRequest

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

buildOAuthConfig, createOAuthRequest, getConnectTimeout, getKey, getOAuthScope, getReadTimeout, getResponseType, getSecret, hasBeenCancelled, hasOAuthGrantType, internalInit, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, setConnectTimeout, setKey, setReadTimeout, setResponseType, setSecret, setTokenAsHeader

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

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, 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

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

Constructor Detail

DropBoxClient

public DropBoxClient()

DropBoxClient

public DropBoxClient(String key,
                     String secret)

Method Detail

getApi

protected com.github.scribejava.core.builder.api.BaseApi<com.github.scribejava.core.oauth.OAuth10aService> getApi()

Description copied from class: BaseOAuthClient

Define the OAuth API for this client.

Specified by:

getApi in class BaseOAuthClient<DropBoxProfile,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

Returns:

the OAuth API

getProfileUrl

protected String getProfileUrl(com.github.scribejava.core.model.OAuth1Token token)

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,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

Parameters:

token - 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)
                                        throws HttpAction

Description copied from class: BaseOAuthClient

Get the OAuth credentials from the web context.

Overrides:

getOAuthCredentials in class BaseOAuth10Client<DropBoxProfile>

Parameters:

context - the web context

Returns:

the OAuth credentials

Throws:

HttpAction - whether an additional HTTP action is required

extractUserProfile

protected DropBoxProfile extractUserProfile(String body)
                                     throws HttpAction

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,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

Parameters:

body - the response body

Returns:

the user profile object

Throws:

HttpAction - whether an additional HTTP action is required