org.pac4j.oauth.client

Class VkClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

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

org.pac4j.oauth.client.VkClient

All Implemented Interfaces:

Client<OAuth20Credentials,VkProfile>

public class VkClient
extends OAuth20Client<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)

Field Summary

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

configuration

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver

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

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	clientInit() Initialize the client.
VkConfiguration	getConfiguration()
String	getFields()
String	getScope()
void	setFields(String fields)
void	setScope(String scope)

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

getKey, getSecret, setConfiguraton, setKey, setSecret, toString

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

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getUserProfile, notifySessionRenewal, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator

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

init

Methods inherited from class java.lang.Object

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

Constructor Detail

VkClient

public VkClient()

VkClient

public VkClient(String key,
                String secret)

Method Detail

clientInit

protected void clientInit()

Description copied from class: IndirectClient

Initialize the client.

Overrides:

clientInit in class OAuth20Client<VkProfile>

getConfiguration

public VkConfiguration getConfiguration()

Overrides:

getConfiguration in class OAuth20Client<VkProfile>

getScope

public String getScope()

setScope

public void setScope(String scope)

getFields

public String getFields()

setFields

public void setFields(String fields)