Package org.pac4j.oauth.client

Class WechatClient

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

All Implemented Interfaces:

org.pac4j.core.client.Client

public class WechatClient
extends OAuth20Client

This class is the OAuth client to authenticate users in Tencent Wechat.

It returns a WechatProfile.

More info at: WeChat login development guide

Since:

3.1.0

Author:

zhangzhenli

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WechatClient.WechatScope

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<WechatClient.WechatScope>	scopes

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
WechatClient()
WechatClient(java.lang.String key, java.lang.String secret)

Method Summary

Modifier and Type	Method	Description
void	addScope(WechatClient.WechatScope scopes)
protected java.lang.String	getOAuthScope()
java.util.List<WechatClient.WechatScope>	getScopes()
protected void	internalInit()
void	setScopes(java.util.List<WechatClient.WechatScope> scopes)

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

beforeInternalInit, getConfiguration, getKey, getSecret, setConfiguration, setKey, setSecret, toString

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

afterInternalInit, computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getUserProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession

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

init, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

scopes

protected java.util.List<WechatClient.WechatScope> scopes

Constructor Detail

WechatClient

public WechatClient()

WechatClient

public WechatClient(java.lang.String key,
                    java.lang.String secret)

Method Detail

internalInit

protected void internalInit()

Overrides:

internalInit in class OAuth20Client

getOAuthScope

protected java.lang.String getOAuthScope()

getScopes

public java.util.List<WechatClient.WechatScope> getScopes()

setScopes

public void setScopes(java.util.List<WechatClient.WechatScope> scopes)

addScope

public void addScope(WechatClient.WechatScope scopes)