org.pac4j.oauth.client

Class OkClient

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.BaseOAuth20Client<OkProfile>

org.pac4j.oauth.client.OkClient

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,OkProfile>

public final class OkClient
extends BaseOAuth20Client<OkProfile>

Since:

1.8

Author:

imayka (imayka[at]ymail[dot]com)

Field Summary

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

logger, OAUTH_CODE

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
OkClient()
OkClient(String key, String secret, String publicKey)

Method Summary

Modifier and Type	Method and Description
BaseOAuthClient<OkProfile>	clone() Clone the current client.
protected OkProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
protected String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
String	getPublicKey()
protected boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit(WebContext context) Internal initialization of the object.
protected BaseClient<OAuthCredentials,OkProfile>	newClient() Create a new instance of the client.
void	setPublicKey(String publicKey)

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

getAccessToken, getOAuthCredentials, isDirectRedirection, retrieveAuthorizationUrl

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

addAccessTokenToProfile, 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

OkClient

public OkClient()

OkClient

public OkClient(String key,
                String secret,
                String publicKey)

Method Detail

newClient

protected BaseClient<OAuthCredentials,OkProfile> newClient()

Description copied from class: BaseClient

Create a new instance of the client.

Specified by:

newClient in class BaseClient<OAuthCredentials,OkProfile>

Returns:

A new instance of the client

hasBeenCancelled

protected boolean hasBeenCancelled(WebContext context)

Description copied from class: BaseOAuthClient

Return if the authentication has been cancelled.

Specified by:

hasBeenCancelled in class BaseOAuthClient<OkProfile>

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.

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<OkProfile>

Parameters:

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

Returns:

the url of the user profile given by the provider

extractUserProfile

protected OkProfile 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<OkProfile>

Parameters:

body - the response body

Returns:

the user profile object

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class BaseOAuthClient<OkProfile>

Parameters:

context - the web context

getPublicKey

public String getPublicKey()

setPublicKey

public void setPublicKey(String publicKey)

clone

public BaseOAuthClient<OkProfile> clone()

Description copied from class: BaseClient

Clone the current client.

Overrides:

clone in class BaseOAuthClient<OkProfile>

Returns:

the cloned client