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

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

公開メンバ関数
SessionId	getConnectSession (HttpServletRequest httpRequest)
SessionId	getSession (HttpServletRequest httpRequest, HttpServletResponse httpResponse, String userDn, boolean create)
void	setAuthenticatedSessionState (HttpServletRequest httpRequest, SessionId sessionId)
boolean	isSessionStateAuthenticated (HttpServletRequest httpRequest)
boolean	persist (SessionId session)
int	getStep (SessionId session)
void	setStep (int step, SessionId session)
void	configure (SessionId session, String scriptName, String clientId, String state)
boolean	isStepPassed (SessionId session, Integer step)
boolean	isPassedPreviousSteps (SessionId session, Integer step)
void	markStep (SessionId session, Integer step, boolean value)
String	getScriptName (SessionId session)
void	setScriptName (SessionId session, String scriptName)
String	getClientId (SessionId session)
void	setClientId (SessionId session, String clientId)
void	resetToStep (SessionId session, int overridenNextStep, int step)
User	getUser (HttpServletRequest httpRequest, String... returnAttributes)
String	getUserDn (HttpServletRequest httpRequest)
Client	getClient (SessionId session)

非公開変数類
Logger	log
SessionIdService	sessionIdService
UserService	userService
ClientService	clientService

詳解

著者

Yuriy Movchan Date: 10/30/2017

関数詳解

configure()

void org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.configure ( SessionId  session, String  scriptName, String  clientId, String  state  )

inline

                                                                                               {
        setStep(1, session);
        setScriptName(session, scriptName);

        setClientId(session, clientId);
        persist(session);
    }

getClient()

Client org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.getClient ( SessionId  session )

inline

                                               {
        String clientId = getClientId(session);
        if (StringUtils.isNotBlank(clientId)) {
            return clientService.getClient(clientId);
        }
        log.trace("client_id is not in session.");
        return null;
    }

getClientId()

String org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.getClientId ( SessionId  session )

inline

                                                 {
        return session.getSessionAttributes().get("client_id");
    }

getConnectSession()

SessionId org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.getConnectSession ( HttpServletRequest  httpRequest )

inline

                                                                       {
        String cookieId = sessionIdService.getSessionIdFromCookie(httpRequest);
        log.trace("Cookie - session_id: ", cookieId);
        if (StringUtils.isNotBlank(cookieId)) {
            return sessionIdService.getSessionId(cookieId);
        }

        return null;
    }

getScriptName()

String org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.getScriptName ( SessionId  session )

inline

                                                   {
        return session.getSessionAttributes().get("gather_script_name");
    }

getSession()

SessionId org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.getSession ( HttpServletRequest  httpRequest, HttpServletResponse  httpResponse, String  userDn, boolean  create  )

inline

                                                                                                                                 {
        String cookieId = sessionIdService.getConsentSessionIdFromCookie(httpRequest);
        log.trace("Cookie - consent_session_id: ", cookieId);

        if (StringUtils.isNotBlank(cookieId)) {
            SessionId sessionId = sessionIdService.getSessionId(cookieId);
            if (sessionId != null) {
                log.trace("Loaded consent_session_id from cookie, session: ", sessionId);
                return sessionId;
            } else {
                log.error("Failed to load consent_session_id from cookie: ", cookieId);
            }
        } else {
            log.error("consent_session_id cookie is not set.");
        }
        
        if (!create) {
                return null;
        }

        log.trace("Generating new consent_session_id ...");
        SessionId session = sessionIdService.generateUnauthenticatedSessionId(userDn);

        sessionIdService.createSessionIdCookie(session.getId(), session.getSessionState(), httpResponse, SessionIdService.CONSENT_SESSION_ID_COOKIE_NAME);
        log.trace("consent_session_id cookie created.");

        return session;
    }

getStep()

int org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.getStep ( SessionId  session )

inline

                                          {
        String stepString = session.getSessionAttributes().get("step");
        int step = Util.parseIntSilently(stepString);
        if (step == -1) {
            step = 1;
            setStep(step, session);
        }
        return step;
    }

getUser()

User org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.getUser ( HttpServletRequest  httpRequest, String...  returnAttributes  )

inline

                                                                                    {
        String userDn = getUserDn(httpRequest);
        if (StringUtils.isNotBlank(userDn)) {
            return userService.getUserByDn(userDn, returnAttributes);
        }

        return null;
    }

getUserDn()

String org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.getUserDn ( HttpServletRequest  httpRequest )

inline

                                                            {
        SessionId connectSession = getConnectSession(httpRequest);
        if (connectSession != null) {
            return connectSession.getUserDn();
        }

        log.trace("No logged in user.");
        return null;
    }

isPassedPreviousSteps()

boolean org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.isPassedPreviousSteps ( SessionId  session, Integer  step  )

inline

                                                                          {
        for (int i = 1; i < step; i++) {
            if (!isStepPassed(session, i)) {
                return false;
            }
        }
        return true;
    }

isSessionStateAuthenticated()

boolean org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.isSessionStateAuthenticated ( HttpServletRequest  httpRequest )

inline

                                                                               {
        final SessionId session = getSession(httpRequest, null, null, false);

        return sessionIdService.isSessionIdAuthenticated(session);
    }

isStepPassed()

boolean org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.isStepPassed ( SessionId  session, Integer  step  )

inline

                                                                 {
        return Boolean.parseBoolean(session.getSessionAttributes().get(String.format("consent_step_passed_%d", step)));
    }

markStep()

void org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.markStep ( SessionId  session, Integer  step, boolean  value  )

inline

                                                                         {
        String key = String.format("consent_step_passed_%d", step);
        if (value) {
            session.getSessionAttributes().put(key, Boolean.TRUE.toString());
        } else {
            session.getSessionAttributes().remove(key);
        }
    }

persist()

boolean org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.persist ( SessionId  session )

inline

                                              {
        try {
            if (sessionIdService.persistSessionId(session, true)) {
                log.trace("Session persisted successfully. Session: " + session);
                return true;
            }
        } catch (Exception e) {
            log.error("Failed to persist session, id: " + session.getId(), e);
        }

        return false;
    }

resetToStep()

void org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.resetToStep ( SessionId  session, int  overridenNextStep, int  step  )

inline

                                                                                {
        for (int i = overridenNextStep; i <= step; i++) {
            markStep(session, i, false);
        }

        setStep(overridenNextStep, session);
    }

setAuthenticatedSessionState()

void org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.setAuthenticatedSessionState ( HttpServletRequest  httpRequest, SessionId  sessionId  )

inline

                                                                                                  {
        SessionId connectSession = getConnectSession(httpRequest);
        sessionIdService.setSessionIdStateAuthenticated(httpRequest, sessionId, connectSession.getDn());
    }

setClientId()

void org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.setClientId ( SessionId  session, String  clientId  )

inline

                                                                {
        session.getSessionAttributes().put("client_id", clientId);
    }

setScriptName()

void org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.setScriptName ( SessionId  session, String  scriptName  )

inline

                                                                    {
        session.getSessionAttributes().put("gather_script_name", scriptName);
    }

setStep()

void org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.setStep ( int  step, SessionId  session  )

inline

                                                     {
        session.getSessionAttributes().put("step", Integer.toString(step));
    }

メンバ詳解

clientService

ClientService org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.clientService

private

log

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

private

sessionIdService

SessionIdService org.xdi.oxauth.authorize.ws.rs.ConsentGatheringSessionService.sessionIdService

private

userService

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

private

---

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

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