org.gluu.oxauth.cas.auth.login.flow.ClientAction クラス

org.gluu.oxauth.cas.auth.login.flow.ClientAction の継承関係図

org.gluu.oxauth.cas.auth.login.flow.ClientAction 連携図

公開メンバ関数
	ClientAction (final AuthClient client, final CentralAuthenticationService centralAuthenticationService)

静的公開変数類
static final String	DEFAULT_CLIENT_NAME_PARAMETER = "client_name"
static final String	SERVICE = "service"
static final String	THEME = "theme"
static final String	LOCALE = "locale"
static final String	METHOD = "method"

限定公開メンバ関数
Event	doExecute (final RequestContext context) throws Exception
void	prepareForLoginPage (final RequestContext context, final WebContext webContext)

非公開メンバ関数
ClientCredential	getClientCrendentials (final RequestContext context, final WebContext webContext)
void	restoreRequestAttribute (final WebContext context, final String name)
void	saveRequestParameter (final WebContext context, final String name)

非公開変数類
final Logger	logger = LoggerFactory.getLogger(ClientAction.class)
final AuthClient	client
final CentralAuthenticationService	centralAuthenticationService

詳解

This class represents an action to do oxAuth authentication in CAS

著者

Yuriy Movchan 11/13/2014

構築子と解体子

ClientAction()

org.gluu.oxauth.cas.auth.login.flow.ClientAction.ClientAction ( final AuthClient  client, final CentralAuthenticationService  centralAuthenticationService  )

inline

Build the action

引数

theCentralAuthenticationService	The service for CAS authentication
theClients	The clients for authentication

                                                                                                                      {
                this.client = client;
                this.centralAuthenticationService = centralAuthenticationService;
        }

関数詳解

doExecute()

Event org.gluu.oxauth.cas.auth.login.flow.ClientAction.doExecute ( final RequestContext  context ) throws Exception

inlineprotected

{}

                                                                                 {
                final HttpServletRequest request = WebUtils.getHttpServletRequest(context);
                final HttpServletResponse response = WebUtils.getHttpServletResponse(context);

                // Web context
                final WebContext webContext = new J2EContext(request, response);

                // It's an authentication
                if (client.isAuthorizationResponse(webContext)) {
                        logger.info("Procession authentication request");

                        // Check if oxAuth request state is correct
                        if (!client.isValidRequestState(webContext)) {
                                logger.warn("The state in session and in request are not equals");

                                // Reinit login page
                                prepareForLoginPage(context, webContext);

                                return new Event(this, "stop");
                        }

                        // Try to authenticate
                        final ClientCredential credentials = getClientCrendentials(context, webContext);
                        if (credentials != null) {
                                WebUtils.putTicketGrantingTicketInRequestScope(context,
                                                this.centralAuthenticationService.createTicketGrantingTicket(credentials));
                                return success();
                        }
                }

                // Go to login page
                prepareForLoginPage(context, webContext);

                return error();
        }

getClientCrendentials()

ClientCredential org.gluu.oxauth.cas.auth.login.flow.ClientAction.getClientCrendentials ( final RequestContext  context, final WebContext  webContext  )

inlineprivate

Build client credenatils from incomming request

引数

context	The current webflow context
webContext	The current web context

戻り値

client credentials

                                                                                                                  {
                final OpenIdCredentials openIdCredentials = client.getCredentials(webContext);
                final ClientCredential credentials = new ClientCredential(openIdCredentials);

                // Retrieve parameters from web session
                final Service service = (Service) webContext.getSessionAttribute(SERVICE);
                if (service != null) {
                        webContext.setRequestAttribute(SERVICE, service.getId());
                }
                context.getFlowScope().put(SERVICE, service);

                restoreRequestAttribute(webContext, THEME);
                restoreRequestAttribute(webContext, LOCALE);
                restoreRequestAttribute(webContext, METHOD);

                return credentials;
        }

prepareForLoginPage()

void org.gluu.oxauth.cas.auth.login.flow.ClientAction.prepareForLoginPage ( final RequestContext  context, final WebContext  webContext  )

inlineprotected

Prepare the data for the login page

引数

context	The current webflow context
webContext	The current web context

                                                                                                      {
                // Save parameters in web session
                final Service service = (Service) context.getFlowScope().get(SERVICE);
                if (service != null) {
                        webContext.setSessionAttribute(SERVICE, service);
                }
                saveRequestParameter(webContext, THEME);
                saveRequestParameter(webContext, LOCALE);
                saveRequestParameter(webContext, METHOD);

                final String keyRedirectionUrl = this.client.getName() + "Url";
                final String redirectionUrl = this.client.getRedirectionUrl(webContext);
                logger.debug("Generated redirection Url", redirectionUrl);

                context.getFlowScope().put(keyRedirectionUrl, redirectionUrl);

                final String keyAuthMethod = this.client.getName() + "OpenIdDefaultAuthenticator";
                final Boolean keyAuthMethodValue = this.client.isOpenIdDefaultAuthenticator();
                logger.debug("OpenIdDefaultAuthenticator", keyAuthMethodValue);

                context.getFlowScope().put(keyAuthMethod, keyAuthMethodValue);
        }

restoreRequestAttribute()

void org.gluu.oxauth.cas.auth.login.flow.ClientAction.restoreRequestAttribute ( final WebContext  context, final String  name  )

inlineprivate

Restore an attribute in web session as an attribute in request

引数

webContext	The current web context
name	The name of the parameter

                                                                                          {
                final String value = (String) context.getSessionAttribute(name);
                context.setRequestAttribute(name, value);
        }

saveRequestParameter()

void org.gluu.oxauth.cas.auth.login.flow.ClientAction.saveRequestParameter ( final WebContext  context, final String  name  )

inlineprivate

Save a request parameter in the web session

引数

webContext	The current web context
name	The name of the parameter

                                                                                       {
                final String value = context.getRequestParameter(name);
                if (value != null) {
                        context.setSessionAttribute(name, value);
                }
        }

メンバ詳解

centralAuthenticationService

final CentralAuthenticationService org.gluu.oxauth.cas.auth.login.flow.ClientAction.centralAuthenticationService

private

client

final AuthClient org.gluu.oxauth.cas.auth.login.flow.ClientAction.client

private

DEFAULT_CLIENT_NAME_PARAMETER

final String org.gluu.oxauth.cas.auth.login.flow.ClientAction.DEFAULT_CLIENT_NAME_PARAMETER = "client_name"

static

LOCALE

final String org.gluu.oxauth.cas.auth.login.flow.ClientAction.LOCALE = "locale"

static

logger

final Logger org.gluu.oxauth.cas.auth.login.flow.ClientAction.logger = LoggerFactory.getLogger(ClientAction.class)

private

METHOD

final String org.gluu.oxauth.cas.auth.login.flow.ClientAction.METHOD = "method"

static

SERVICE

final String org.gluu.oxauth.cas.auth.login.flow.ClientAction.SERVICE = "service"

static

Constants to store request parameters

THEME

final String org.gluu.oxauth.cas.auth.login.flow.ClientAction.THEME = "theme"

static

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/oxTrust/cas-openid-auth-client/src/main/java/org/gluu/oxauth/cas/auth/login/flow/ClientAction.java