org.pac4j.oauth.client

Class CasOAuthWrapperClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

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

org.pac4j.oauth.client.CasOAuthWrapperClient

All Implemented Interfaces:

Client<OAuth20Credentials,CasOAuthWrapperProfile>

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

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

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

logger

Constructor Summary

Constructors

Constructor and Description
CasOAuthWrapperClient()
CasOAuthWrapperClient(String key, String secret, String casOAuthUrl)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit(WebContext context) Initialize the client.
String	getCasLogoutUrl()
String	getCasOAuthUrl()
boolean	isImplicitFlow()
boolean	isSpringSecurityCompliant()
void	setCasLogoutUrl(String casLogoutUrl)
void	setCasOAuthUrl(String casOAuthUrl)
void	setImplicitFlow(boolean implicitFlow)
void	setSpringSecurityCompliant(boolean springSecurityCompliant)

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, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver

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

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

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

init, reinit

Methods inherited from class java.lang.Object

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

clientInit

protected void clientInit(WebContext context)

Description copied from class: IndirectClient

Initialize the client.

Overrides:

clientInit in class OAuth20Client<CasOAuthWrapperProfile>

Parameters:

context - the web context

getCasOAuthUrl

public String getCasOAuthUrl()

setCasOAuthUrl

public void setCasOAuthUrl(String casOAuthUrl)

isSpringSecurityCompliant

public boolean isSpringSecurityCompliant()

setSpringSecurityCompliant

public void setSpringSecurityCompliant(boolean springSecurityCompliant)

isImplicitFlow

public boolean isImplicitFlow()

setImplicitFlow

public void setImplicitFlow(boolean implicitFlow)

getCasLogoutUrl

public String getCasLogoutUrl()

setCasLogoutUrl

public void setCasLogoutUrl(String casLogoutUrl)