Package org.pac4j.oauth.client

Class WechatClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

org.pac4j.oauth.client.OAuth20Client

org.pac4j.oauth.client.WechatClient

All Implemented Interfaces:

Client<OAuth20Credentials>

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

Constructor Summary

Constructors

Constructor	Description
WechatClient()
WechatClient(String key, String secret)

Method Summary

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

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

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

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

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

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

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

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 List<WechatClient.WechatScope> scopes

Constructor Detail

WechatClient

public WechatClient()

WechatClient

public WechatClient(String key,
                    String secret)

Method Detail

clientInit

protected void clientInit()

Overrides:

clientInit in class OAuth20Client

getOAuthScope

protected String getOAuthScope()

getScopes

public List<WechatClient.WechatScope> getScopes()

setScopes

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

addScope

public void addScope(WechatClient.WechatScope scopes)