org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel > クラステンプレート

org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel > の継承関係図

org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel > 連携図

公開メンバ関数
	AbstractIdentityProvider (KeycloakSession session, C config)
C	getConfig ()
Response	export (UriInfo uriInfo, RealmModel realm, String format)
void	close ()
Object	callback (RealmModel realm, AuthenticationCallback callback, EventBuilder event)
Response	performLogin (AuthenticationRequest request)
Response	keycloakInitiatedBrowserLogout (KeycloakSession session, UserSessionModel userSession, UriInfo uriInfo, RealmModel realm)
void	backchannelLogout (KeycloakSession session, UserSessionModel userSession, UriInfo uriInfo, RealmModel realm)
Response	exchangeNotSupported ()
Response	exchangeNotLinked (UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
Response	exchangeNotLinkedNoStore (UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
Response	exchangeTokenExpired (UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject)
Response	exchangeUnsupportedRequiredType ()
void	authenticationFinished (AuthenticationSessionModel authSession, BrokeredIdentityContext context)
void	preprocessFederatedIdentity (KeycloakSession session, RealmModel realm, BrokeredIdentityContext context)
void	importNewUser (KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
void	updateBrokeredUser (KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
IdentityProviderDataMarshaller	getMarshaller ()
Response	retrieveToken (KeycloakSession session, FederatedIdentityModel identity)

公開変数類
String	EXTERNAL_IDENTITY_PROVIDER
String	FEDERATED_ACCESS_TOKEN

静的公開変数類
static final String	ACCOUNT_LINK_URL = "account-link-url"

限定公開メンバ関数
Response	exchangeErrorResponse (UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, String errorCode, String reason)
String	getLinkingUrl (UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession)

限定公開変数類
final KeycloakSession	session

非公開変数類
final C	config

詳解

著者

Pedro Igor

構築子と解体子

AbstractIdentityProvider()

org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.AbstractIdentityProvider ( KeycloakSession  session, C  config  )

inline

                                                                       {
        this.session = session;
        this.config = config;
    }

関数詳解

authenticationFinished()

void org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.authenticationFinished ( AuthenticationSessionModel  authSession, BrokeredIdentityContext  context  )

inline

                                                                                                                {

    }

backchannelLogout()

void org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.backchannelLogout ( KeycloakSession  session, UserSessionModel  userSession, UriInfo  uriInfo, RealmModel  realm  )

inline

                                                                                                                            {

    }

callback()

Object org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.callback ( RealmModel  realm, AuthenticationCallback  callback, EventBuilder  event  )

inline

                                                                                                  {
        return null;
    }

close()

void org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.close ( )

inline

                        {
        // no-op
    }

exchangeErrorResponse()

Response org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.exchangeErrorResponse ( UriInfo  uriInfo, ClientModel  authorizedClient, UserSessionModel  tokenUserSession, String  errorCode, String  reason  )

inlineprotected

                                                                                                                                                                {
        Map<String, String> error = new HashMap<>();
        error.put("error", errorCode);
        error.put("error_description", reason);
        String accountLinkUrl = getLinkingUrl(uriInfo, authorizedClient, tokenUserSession);
        if (accountLinkUrl != null) error.put(ACCOUNT_LINK_URL, accountLinkUrl);
        return Response.status(400).entity(error).type(MediaType.APPLICATION_JSON_TYPE).build();
    }

exchangeNotLinked()

Response org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.exchangeNotLinked ( UriInfo  uriInfo, ClientModel  authorizedClient, UserSessionModel  tokenUserSession, UserModel  tokenSubject  )

inline

                                                                                                                                                {
        return exchangeErrorResponse(uriInfo, authorizedClient, tokenUserSession, "not_linked", "identity provider is not linked");
    }

exchangeNotLinkedNoStore()

Response org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.exchangeNotLinkedNoStore ( UriInfo  uriInfo, ClientModel  authorizedClient, UserSessionModel  tokenUserSession, UserModel  tokenSubject  )

inline

                                                                                                                                                       {
        return exchangeErrorResponse(uriInfo, authorizedClient, tokenUserSession, "not_linked", "identity provider is not linked, can only link to current user session");
    }

exchangeNotSupported()

Response org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.exchangeNotSupported ( )

inline

                                           {
        Map<String, String> error = new HashMap<>();
        error.put("error", "invalid_target");
        error.put("error_description", "target_exchange_unsupported");
        return  Response.status(400).entity(error).type(MediaType.APPLICATION_JSON_TYPE).build();
    }

exchangeTokenExpired()

Response org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.exchangeTokenExpired ( UriInfo  uriInfo, ClientModel  authorizedClient, UserSessionModel  tokenUserSession, UserModel  tokenSubject  )

inline

                                                                                                                                                   {
        return exchangeErrorResponse(uriInfo, authorizedClient, tokenUserSession, "token_expired", "linked token is expired");
    }

exchangeUnsupportedRequiredType()

Response org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.exchangeUnsupportedRequiredType ( )

inline

                                                      {
        Map<String, String> error = new HashMap<>();
        error.put("error", "invalid_target");
        error.put("error_description", "response_token_type_unsupported");
        return Response.status(400).entity(error).type(MediaType.APPLICATION_JSON_TYPE).build();
    }

export()

Response org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.export ( UriInfo  uriInfo, RealmModel  realm, String  format  )

inline

                                                                             {
        return Response.noContent().build();
    }

getConfig()

C org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.getConfig ( )

inline

                         {
        return this.config;
    }

getLinkingUrl()

String org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.getLinkingUrl ( UriInfo  uriInfo, ClientModel  authorizedClient, UserSessionModel  tokenUserSession  )

inlineprotected

                                                                                                                     {
        String provider = getConfig().getAlias();
        String clientId = authorizedClient.getClientId();
        String nonce = UUID.randomUUID().toString();
        MessageDigest md = null;
        try {
            md = MessageDigest.getInstance("SHA-256");
        } catch (NoSuchAlgorithmException e) {
            throw new RuntimeException(e);
        }
        String input = nonce + tokenUserSession.getId() + clientId + provider;
        byte[] check = md.digest(input.getBytes(StandardCharsets.UTF_8));
        String hash = Base64Url.encode(check);
        return KeycloakUriBuilder.fromUri(uriInfo.getBaseUri())
                .path("/realms/{realm}/broker/{provider}/link")
                .queryParam("nonce", nonce)
                .queryParam("hash", hash)
                .queryParam("client_id", clientId)
                .build(authorizedClient.getRealm().getName(), provider)
                .toString();
    }

getMarshaller()

IdentityProviderDataMarshaller org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.getMarshaller ( )

inline

                                                          {
        return new DefaultDataMarshaller();
    }

importNewUser()

void org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.importNewUser ( KeycloakSession  session, RealmModel  realm, UserModel  user, BrokeredIdentityContext  context  )

inline

                                                                                                                          {

    }

keycloakInitiatedBrowserLogout()

Response org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.keycloakInitiatedBrowserLogout ( KeycloakSession  session, UserSessionModel  userSession, UriInfo  uriInfo, RealmModel  realm  )

inline

                                                                                                                                             {
        return null;
    }

performLogin()

Response org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.performLogin ( AuthenticationRequest  request )

inline

                                                                {
        return null;
    }

preprocessFederatedIdentity()

void org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.preprocessFederatedIdentity ( KeycloakSession  session, RealmModel  realm, BrokeredIdentityContext  context  )

inline

                                                                                                                        {

    }

retrieveToken()

Response org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.retrieveToken ( KeycloakSession  session, FederatedIdentityModel  identity  )

inherited

Returns a javax.ws.rs.core.Response containing the token previously stored during the authentication process for a specific user.

引数

identity

戻り値

updateBrokeredUser()

void org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.updateBrokeredUser ( KeycloakSession  session, RealmModel  realm, UserModel  user, BrokeredIdentityContext  context  )

inline

                                                                                                                               {

    }

メンバ詳解

ACCOUNT_LINK_URL

final String org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.ACCOUNT_LINK_URL = "account-link-url"

static

config

final C org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.config

private

EXTERNAL_IDENTITY_PROVIDER

String org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.EXTERNAL_IDENTITY_PROVIDER

inherited

FEDERATED_ACCESS_TOKEN

String org.keycloak.broker.provider.IdentityProvider< C extends IdentityProviderModel >.FEDERATED_ACCESS_TOKEN

inherited

session

final KeycloakSession org.keycloak.broker.provider.AbstractIdentityProvider< C extends IdentityProviderModel >.session

protected

---

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

• D:/AppData/doxygen/keycloak/spi-private/src/server-spi-private/src/main/java/org/keycloak/broker/provider/AbstractIdentityProvider.java