org.pac4j.oauth.client

Class VkClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

org.pac4j.oauth.client.BaseOAuth20Client<VkProfile>

org.pac4j.oauth.client.VkClient

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,VkProfile>

public class VkClient
extends BaseOAuth20Client<VkProfile>

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

The scope can be defined to require specific permissions from the user by using the setScope(String) method. By default, the scope is : PERMISSIONS.

It returns a VkProfile.

More information at https://vk.com/dev/users.get

Since:

1.5

Author:

indvdum (gotoindvdum[at]gmail[dot]com)

See Also:

VkProfile

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BASE_URL
static String	DEFAULT_FIELDS
static String	DEFAULT_SCOPE
protected String	fields
protected String	scope

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.BaseClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected VkProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
String	getFields()
protected String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
String	getScope()
protected boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit()
protected VkClient	newClient()
protected boolean	requiresStateParameter() Return if this client requires a state parameter.
void	setFields(String fields)
void	setScope(String scope)

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

getAccessToken, getOAuthCredentials, isDirectRedirection, retrieveAuthorizationUrl

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

addAccessTokenToProfile, clone, createProxyRequest, getConnectTimeout, getKey, getProtocol, 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.BaseClient

addAuthorizationGenerator, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getRedirectAction, getRedirectionUrl, getUserProfile, isEnableContextualRedirects, prependHostToUrlIfNotPresent, redirect, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setName, toString

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

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FIELDS

public static final String DEFAULT_FIELDS

See Also:

Constant Field Values

fields

protected String fields

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

See Also:

Constant Field Values

scope

protected String scope

BASE_URL

protected static final String BASE_URL

See Also:

Constant Field Values

Constructor Detail

VkClient

public VkClient()

VkClient

public VkClient(String key,
        String secret)

Method Detail

newClient

protected VkClient newClient()

Specified by:

newClient in class BaseClient<OAuthCredentials,VkProfile>

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseOAuthClient<VkProfile>

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

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

Returns:

the user profile object

requiresStateParameter

protected boolean requiresStateParameter()

Description copied from class: BaseOAuth20Client

Return if this client requires a state parameter.

Specified by:

requiresStateParameter in class BaseOAuth20Client<VkProfile>

Returns:

if this client requires a state parameter.

hasBeenCancelled

protected boolean hasBeenCancelled(WebContext context)

Description copied from class: BaseOAuthClient

Return if the authentication has been cancelled.

Specified by:

hasBeenCancelled in class BaseOAuthClient<VkProfile>

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.

getScope

public String getScope()

setScope

public void setScope(String scope)

getFields

public String getFields()

setFields

public void setFields(String fields)