Package org.pac4j.oauth.client

Class VkClient

java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.IndirectClient
org.pac4j.oauth.client.OAuth20Client
org.pac4j.oauth.client.VkClient
All Implemented Interfaces:
org.pac4j.core.client.Client
public class VkClient extends OAuth20Client

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    VkClient()
    Constructor for VkClient.
    VkClient(String key, String secret)
    Constructor for VkClient.

  • Method Summary

    Modifier and Type
    Method
    Description
    VkConfiguration
    getConfiguration()
    String
    getFields()
    getFields.
    String
    getScope()
    getScope.
    protected void
    internalInit(boolean forceReinit)
    void
    setFields(String fields)
    setFields.
    void
    setScope(String scope)
    setScope.

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

    beforeInternalInit, getKey, getSecret, setKey, setSecret

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

    afterInternalInit, checkCredentials, computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getLogoutAction, getLogoutActionBuilder, getLogoutProcessor, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, processLogout, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setLogoutActionBuilderIfUndefined, setLogoutProcessor, setLogoutProcessorIfUndefined, setRedirectionActionBuilder, setRedirectionActionBuilderIfUndefined, setUrlResolver, toString

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

    addAuthorizationGenerator, addAuthorizationGenerators, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentials, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, validateCredentials

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

    getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • VkClient

      public VkClient()

      Constructor for VkClient.

    • VkClient

      public VkClient(String key, String secret)

      Constructor for VkClient.

      Parameters:
      key - a String object
      secret - a String object

  • Method Details

    • internalInit

      protected void internalInit(boolean forceReinit)
      Overrides:
      internalInit in class OAuth20Client

    • getConfiguration

      public VkConfiguration getConfiguration()

    • getScope

      public String getScope()

      getScope.

      Returns:
      a String object

    • setScope

      public void setScope(String scope)

      setScope.

      Parameters:
      scope - a String object

    • getFields

      public String getFields()

      getFields.

      Returns:
      a String object

    • setFields

      public void setFields(String fields)

      setFields.

      Parameters:
      fields - a String object