org.pac4j.gae.client

Class GaeUserServiceClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

org.pac4j.core.client.IndirectClient<GaeUserCredentials,GaeUserServiceProfile>

org.pac4j.gae.client.GaeUserServiceClient

All Implemented Interfaces:

Client<GaeUserCredentials,GaeUserServiceProfile>

public class GaeUserServiceClient
extends IndirectClient<GaeUserCredentials,GaeUserServiceProfile>

This class is the OpenID client to authenticate users with UserService on App Engine

Since:

1.6.0

Author:

Patrice de Saint Steban

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authDomain
protected com.google.appengine.api.users.UserService	service

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver

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

logger

Constructor Summary

Constructors

Constructor and Description
GaeUserServiceClient()

Method Summary

Modifier and Type	Method and Description
String	getAuthDomain()
protected void	internalInit(WebContext context) Internal initialization of the object.
protected GaeUserCredentials	retrieveCredentials(WebContext context) Retrieve the credentials.
protected RedirectAction	retrieveRedirectAction(WebContext context) Retrieve the redirect action.
protected GaeUserServiceProfile	retrieveUserProfile(GaeUserCredentials credentials, WebContext context) Retrieve a user userprofile.
void	setAuthDomain(String authDomain) Set the authDomain for connect to google apps for domain with the UserService

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

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl, toString

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

addAuthorizationGenerator, addAuthorizationGenerators, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName

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

Field Detail

service

protected com.google.appengine.api.users.UserService service

authDomain

protected String authDomain

Constructor Detail

GaeUserServiceClient

public GaeUserServiceClient()

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class IndirectClient<GaeUserCredentials,GaeUserServiceProfile>

Parameters:

context - the web context

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)

Description copied from class: IndirectClient

Retrieve the redirect action.

Specified by:

retrieveRedirectAction in class IndirectClient<GaeUserCredentials,GaeUserServiceProfile>

Parameters:

context - the web context

Returns:

the redirection action

retrieveCredentials

protected GaeUserCredentials retrieveCredentials(WebContext context)
                                          throws HttpAction

Description copied from class: BaseClient

Retrieve the credentials.

Specified by:

retrieveCredentials in class BaseClient<GaeUserCredentials,GaeUserServiceProfile>

Parameters:

context - the web context

Returns:

the credentials

Throws:

HttpAction - whether an additional HTTP action is required

retrieveUserProfile

protected GaeUserServiceProfile retrieveUserProfile(GaeUserCredentials credentials,
                                                    WebContext context)
                                             throws HttpAction

Description copied from class: BaseClient

Retrieve a user userprofile.

Specified by:

retrieveUserProfile in class BaseClient<GaeUserCredentials,GaeUserServiceProfile>

Parameters:

credentials - the credentials

context - the web context

Returns:

the user profile

Throws:

HttpAction - whether an additional HTTP action is required

setAuthDomain

public void setAuthDomain(String authDomain)

Set the authDomain for connect to google apps for domain with the UserService

Parameters:

authDomain - the authentication domain

getAuthDomain

public String getAuthDomain()