org.pac4j.oauth.client

Class CasOAuthWrapperClient

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

org.pac4j.oauth.client.CasOAuthWrapperClient

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,CasOAuthWrapperProfile>

public class CasOAuthWrapperClient
extends BaseOAuth20Client<CasOAuthWrapperProfile>

This class is the OAuth client to authenticate users on CAS servers using OAuth wrapper.

The url of the OAuth endpoint of the CAS server must be set by using the setCasOAuthUrl(String) method.

It returns a CasOAuthWrapperProfile.

More information at https://wiki.jasig.org/display/CASUM/OAuth+server+support

Since:

1.3.0

Author:

Jerome Leleu

See Also:

CasOAuthWrapperProfile

Field Summary

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
CasOAuthWrapperClient()
CasOAuthWrapperClient(String key, String secret, String casOAuthUrl)

Method Summary

Methods

Modifier and Type	Method and Description
protected CasOAuthWrapperProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
String	getCasOAuthUrl()
protected String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
protected boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit()
boolean	isSpringSecurityCompliant()
protected CasOAuthWrapperClient	newClient()
protected boolean	requiresStateParameter() Return if this client requires a state parameter.
void	setCasOAuthUrl(String casOAuthUrl)
void	setSpringSecurityCompliant(boolean springSecurityCompliant)

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

Constructor Detail

CasOAuthWrapperClient

public CasOAuthWrapperClient()

CasOAuthWrapperClient

public CasOAuthWrapperClient(String key,
                     String secret,
                     String casOAuthUrl)

Method Detail

newClient

protected CasOAuthWrapperClient newClient()

Specified by:

newClient in class BaseClient<OAuthCredentials,CasOAuthWrapperProfile>

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseOAuthClient<CasOAuthWrapperProfile>

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

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

Returns:

the user profile object

getCasOAuthUrl

public String getCasOAuthUrl()

setCasOAuthUrl

public void setCasOAuthUrl(String casOAuthUrl)

isSpringSecurityCompliant

public boolean isSpringSecurityCompliant()

setSpringSecurityCompliant

public void setSpringSecurityCompliant(boolean springSecurityCompliant)

requiresStateParameter

protected boolean requiresStateParameter()

Description copied from class: BaseOAuth20Client

Return if this client requires a state parameter.

Specified by:

requiresStateParameter in class BaseOAuth20Client<CasOAuthWrapperProfile>

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

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.