org.xdi.oxauth.authorize.ws.rs.ConsentGathererService クラス

org.xdi.oxauth.authorize.ws.rs.ConsentGathererService 連携図

公開メンバ関数
boolean	configure (String userDn, String clientId, String state)
boolean	authorize ()
String	prepareForStep ()
String	result (String resultCode)
void	addMessage (FacesMessage.Severity severity, String summary)
Map< String, String >	getPageAttributes ()
boolean	isConsentGathered ()
ConsentGatheringContext	getContext ()

限定公開メンバ関数
CustomScriptConfiguration	getScript (final SessionId session)

非公開メンバ関数
void	onSuccess (HttpServletRequest httpRequest, SessionId session, ConsentGatheringContext context)
void	errorPage (String errorKey)

非公開変数類
Logger	log
ExternalConsentGatheringService	external
AppConfiguration	appConfiguration
FacesContext	facesContext
ExternalContext	externalContext
FacesService	facesService
LanguageBean	languageBean
ConsentGatheringSessionService	sessionService
UserService	userService
AuthorizeService	authorizeService
final Map< String, String >	pageAttributes = new HashMap<String, String>()
ConsentGatheringContext	context

詳解

著者

Yuriy Movchan Date: 10/30/2017

関数詳解

addMessage()

void org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.addMessage ( FacesMessage.Severity  severity, String  summary  )

inline

                                                                           {
        String msg = languageBean.getMessage(summary);
        FacesMessage message = new FacesMessage(severity, msg, null);
        facesContext.addMessage(null, message);
    }

authorize()

boolean org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.authorize ( )

inline

                               {
        try {
            final HttpServletRequest httpRequest = (HttpServletRequest) externalContext.getRequest();
            final HttpServletResponse httpResponse = (HttpServletResponse) externalContext.getResponse();

            final SessionId session = sessionService.getSession(httpRequest, httpResponse, null, false);
            if (session == null) {
                log.error("Failed to restore claim-gathering session state");
                errorPage("consent.gather.invalid.session");
                return false;
            }

            CustomScriptConfiguration script = getScript(session);
            if (script == null) {
                log.error("Failed to find script '{}' in session:", sessionService.getScriptName(session));
                errorPage("consent.gather.failed");
                return false;
            }

            int step = sessionService.getStep(session);
            if (!sessionService.isPassedPreviousSteps(session, step)) {
                log.error("There are consent-gathering steps not marked as passed. scriptName: '{}', step: '{}'", script.getName(), step);
                errorPage("consent.gather.invalid.step");
                return false;
            }

            this.context = new ConsentGatheringContext(script.getConfigurationAttributes(), httpRequest, httpResponse, session,
                    pageAttributes, sessionService, userService, facesService, appConfiguration);
            boolean authorizeResult = external.authorize(script, step, context);
            log.debug("Consent-gathering result for script '{}', step: '{}', gatheredResult: '{}'", script.getName(), step, authorizeResult);

            int overridenNextStep = external.getNextStep(script, step, context);
            if (!authorizeResult && overridenNextStep == -1) {
                SessionId connectSession = sessionService.getConnectSession(httpRequest);
                authorizeService.permissionDenied(connectSession);
                return false;
            }

            if (overridenNextStep != -1) {
                sessionService.resetToStep(session, overridenNextStep, step);
                step = overridenNextStep;
            }

            int stepsCount = external.getStepsCount(script, context);
            if (step < stepsCount || overridenNextStep != -1) {
                int nextStep;
                if (overridenNextStep != -1) {
                    nextStep = overridenNextStep;
                } else {
                    nextStep = step + 1;
                    sessionService.markStep(session, step, true);
                }

                sessionService.setStep(nextStep, session);

                String redirectTo = external.getPageForStep(script, nextStep, context);
                context.persist();

                log.trace("Redirecting to page: '{}'", redirectTo);
                        facesService.redirectWithExternal(redirectTo, null);

                        return true;
            }

            if (step == stepsCount) {
                context.persist();
                onSuccess(httpRequest, session, context);
                return true;
            }
        } catch (Exception e) {
            log.error("Exception during gather() method call.", e);
        }

        log.error("Failed to perform gather() method successfully.");
        errorPage("consent.gather.failed");
        return false;
    }

configure()

boolean org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.configure ( String  userDn, String  clientId, String  state  )

inline

                                                                           {
        final HttpServletRequest httpRequest = (HttpServletRequest) externalContext.getRequest();
        final HttpServletResponse httpResponse = (HttpServletResponse) externalContext.getResponse();

        final SessionId session = sessionService.getSession(httpRequest, httpResponse, userDn, true);

        CustomScriptConfiguration script = external.getDefaultExternalCustomScript();
        if (script == null) {
            log.error("Failed to determine consent-gathering default script");
            return false;
        }

        sessionService.configure(session, script.getName(), clientId, state);

        this.context = new ConsentGatheringContext(script.getConfigurationAttributes(), httpRequest, httpResponse, session,
                        pageAttributes, sessionService, userService, facesService, appConfiguration);
        log.debug("Configuring consent-gathering script '{}'", script.getName());

        int step = sessionService.getStep(session);
        String redirectTo = external.getPageForStep(script, step, context);
        if (StringHelper.isEmpty(redirectTo)) {
            log.error("Failed to determine page for consent-gathering script");
                return false;
        }

        context.persist();

        log.trace("Redirecting to page: '{}'", redirectTo);
                facesService.redirectWithExternal(redirectTo, null);

                return true;
    }

errorPage()

void org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.errorPage ( String  errorKey )

inlineprivate

                                            {
        addMessage(FacesMessage.SEVERITY_ERROR, errorKey);
        facesService.redirect("/error.xhtml");
    }

getContext()

ConsentGatheringContext org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.getContext ( )

inline

                                                    {
                return context;
        }

getPageAttributes()

Map<String, String> org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.getPageAttributes ( )

inline

                                                   {
        return pageAttributes;
    }

getScript()

CustomScriptConfiguration org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.getScript ( final SessionId  session )

inlineprotected

                                                                           {
                String scriptName = sessionService.getScriptName(session);
                CustomScriptConfiguration script = external.getCustomScriptConfigurationByName(scriptName);

                return script;
        }

isConsentGathered()

boolean org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.isConsentGathered ( )

inline

                                           {
        final HttpServletRequest httpRequest = (HttpServletRequest) externalContext.getRequest();
        return sessionService.isSessionStateAuthenticated(httpRequest);
        }

onSuccess()

void org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.onSuccess ( HttpServletRequest  httpRequest, SessionId  session, ConsentGatheringContext  context  )

inlineprivate

                                                                                                               {
        sessionService.setAuthenticatedSessionState(httpRequest, session);
        
        SessionId connectSessionId = sessionService.getConnectSession(httpRequest);
        
        authorizeService.permissionGranted(httpRequest, connectSessionId);
    }

prepareForStep()

String org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.prepareForStep ( )

inline

                                   {
        try {
            final HttpServletRequest httpRequest = (HttpServletRequest) externalContext.getRequest();
            final HttpServletResponse httpResponse = (HttpServletResponse) externalContext.getResponse();

            final SessionId session = sessionService.getSession(httpRequest, httpResponse, null, false);
            if (session == null || session.getSessionAttributes().isEmpty()) {
                log.error("Failed to restore claim-gathering session state");
                return result(Constants.RESULT_EXPIRED);
            }

            CustomScriptConfiguration script = getScript(session);
            if (script == null) {
                log.error("Failed to find script '{}' in session:", sessionService.getScriptName(session));
                return result(Constants.RESULT_FAILURE);
            }

            int step = sessionService.getStep(session);
            if (step < 1) {
                log.error("Invalid step: {}", step);
                return result(Constants.RESULT_INVALID_STEP);
            }

            if (!sessionService.isPassedPreviousSteps(session, step)) {
                log.error("There are consent-gathering steps not marked as passed. scriptName: '{}', step: '{}'", script.getName(), step);
                return result(Constants.RESULT_FAILURE);
            }

            this.context = new ConsentGatheringContext(script.getConfigurationAttributes(), httpRequest, httpResponse, session,
                        pageAttributes, sessionService, userService, facesService, appConfiguration);
            boolean result = external.prepareForStep(script, step, context);
            log.debug("Consent-gathering prepare for step result for script '{}', step: '{}', gatheredResult: '{}'", script.getName(), step, result);
            if (result) {
                context.persist();
                return result(Constants.RESULT_SUCCESS);
            }
        } catch (Exception ex) {
            log.error("Failed to prepareForStep()", ex);
        }

        return result(Constants.RESULT_FAILURE);
    }

result()

String org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.result ( String  resultCode )

inline

                                            {
        if (Constants.RESULT_FAILURE.equals(resultCode)) {
            addMessage(FacesMessage.SEVERITY_ERROR, "consent.gather.failed");
        } else if (Constants.RESULT_INVALID_STEP.equals(resultCode)) {
            addMessage(FacesMessage.SEVERITY_ERROR, "consent.gather.invalid.step");
        } else if (Constants.RESULT_EXPIRED.equals(resultCode)) {
            addMessage(FacesMessage.SEVERITY_ERROR, "consent.gather.invalid.session");
        }
        return resultCode;
    }

メンバ詳解

appConfiguration

AppConfiguration org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.appConfiguration

private

authorizeService

AuthorizeService org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.authorizeService

private

context

ConsentGatheringContext org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.context

private

external

ExternalConsentGatheringService org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.external

private

externalContext

ExternalContext org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.externalContext

private

facesContext

FacesContext org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.facesContext

private

facesService

FacesService org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.facesService

private

languageBean

LanguageBean org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.languageBean

private

log

Logger org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.log

private

pageAttributes

final Map<String, String> org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.pageAttributes = new HashMap<String, String>()

private

sessionService

ConsentGatheringSessionService org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.sessionService

private

userService

UserService org.xdi.oxauth.authorize.ws.rs.ConsentGathererService.userService

private

---

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

• D:/AppData/OpenId/gluu/src/oxAuth/Server/src/main/java/org/xdi/oxauth/authorize/ws/rs/ConsentGathererService.java