org.keycloak.services.util.BrowserHistoryHelper クラス

org.keycloak.services.util.BrowserHistoryHelper の継承関係図

org.keycloak.services.util.BrowserHistoryHelper 連携図

クラス
class	JavascriptHistoryReplace
class	NoOpHelper
class	RedirectAfterPostHelper

公開メンバ関数
abstract Response	saveResponseAndRedirect (KeycloakSession session, AuthenticationSessionModel authSession, Response response, boolean actionRequest, HttpRequest httpRequest)
abstract Response	loadSavedResponse (KeycloakSession session, AuthenticationSessionModel authSession)

静的公開メンバ関数
static BrowserHistoryHelper	getInstance ()

静的公開変数類
static final String	SHOULD_UPDATE_BROWSER_HISTORY = "SHOULD_UPDATE_BROWSER_HISTORY"

限定公開メンバ関数
boolean	shouldReplaceBrowserHistory (boolean actionRequest, HttpRequest httpRequest)

静的限定公開変数類
static final Logger	logger = Logger.getLogger(BrowserHistoryHelper.class)

詳解

The point of this is to improve experience of browser history (back/forward/refresh buttons), but ensure there is no more redirects then necessary.

Ideally we want to:

• Remove all POST requests from browser history, because browsers don't automatically re-send them when click "back" button. POSTS in history causes unfriendly dialogs and browser "Page is expired" pages.
• Keep the browser URL to match the flow and execution from authentication session. This means that browser refresh works fine and show us the correct form.
• Avoid redirects. This is possible with javascript based approach (JavascriptHistoryReplace). The RedirectAfterPostHelper requires one redirect after POST, but works even on browser without javascript and on old browsers where "history.replaceState" is unsupported.

著者

Marek Posolda

関数詳解

getInstance()

static BrowserHistoryHelper org.keycloak.services.util.BrowserHistoryHelper.getInstance ( )

inlinestatic

                                                     {
        return new JavascriptHistoryReplace();
        //return new RedirectAfterPostHelper();
        //return new NoOpHelper();
    }

loadSavedResponse()

abstract Response org.keycloak.services.util.BrowserHistoryHelper.loadSavedResponse ( KeycloakSession  session, AuthenticationSessionModel  authSession  )

abstract

saveResponseAndRedirect()

abstract Response org.keycloak.services.util.BrowserHistoryHelper.saveResponseAndRedirect ( KeycloakSession  session, AuthenticationSessionModel  authSession, Response  response, boolean  actionRequest, HttpRequest  httpRequest  )

abstract

shouldReplaceBrowserHistory()

boolean org.keycloak.services.util.BrowserHistoryHelper.shouldReplaceBrowserHistory ( boolean  actionRequest, HttpRequest  httpRequest  )

inlineprotected

                                                                                                  {
        if (actionRequest) {
            return true;
        }

        Boolean flowChanged = (Boolean) httpRequest.getAttribute(SHOULD_UPDATE_BROWSER_HISTORY);
        return (flowChanged != null && flowChanged);
    }

メンバ詳解

logger

final Logger org.keycloak.services.util.BrowserHistoryHelper.logger = Logger.getLogger(BrowserHistoryHelper.class)

staticprotected

SHOULD_UPDATE_BROWSER_HISTORY

final String org.keycloak.services.util.BrowserHistoryHelper.SHOULD_UPDATE_BROWSER_HISTORY = "SHOULD_UPDATE_BROWSER_HISTORY"

static

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/util/BrowserHistoryHelper.java