org.keycloak.services.resources

Class IdentityBrokerService

java.lang.Object

org.keycloak.services.resources.IdentityBrokerService

All Implemented Interfaces:

IdentityProvider.AuthenticationCallback

public class IdentityBrokerService
extends Object
implements IdentityProvider.AuthenticationCallback

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
IdentityBrokerService(RealmModel realmModel)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	afterFirstBrokerLogin(String code)
javax.ws.rs.core.Response	afterPostBrokerLoginFlow(String code)
javax.ws.rs.core.Response	authenticated(BrokeredIdentityContext context)
protected javax.ws.rs.core.Response	browserAuthentication(ClientSessionModel clientSession, String errorMessage)
javax.ws.rs.core.Response	cancelled(String code)
javax.ws.rs.core.Response	error(String code, String message)
Object	getEndpoint(String providerId)
static IdentityProvider	getIdentityProvider(KeycloakSession session, RealmModel realm, String alias)
void	init()
protected boolean	isClientSessionRegistered(String code) Returns true if the client session is defined for the given code in the current session and for the current realm.
javax.ws.rs.core.Response	performLogin(String providerId, String code)
javax.ws.rs.core.Response	performPostLogin(String providerId, String code)
javax.ws.rs.core.Response	retrieveToken(String providerId)
javax.ws.rs.core.Response	retrieveTokenPreflight()
javax.ws.rs.core.Response	validateUser(UserModel user, RealmModel realm)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdentityBrokerService

public IdentityBrokerService(RealmModel realmModel)

Method Detail

init

public void init()

performPostLogin

@POST
 @Path(value="/{provider_id}/login")
public javax.ws.rs.core.Response performPostLogin(@PathParam(value="provider_id")
                                                                                             String providerId,
                                                                                             @QueryParam(value="code")
                                                                                             String code)

performLogin

@GET
 @Path(value="/{provider_id}/login")
public javax.ws.rs.core.Response performLogin(@PathParam(value="provider_id")
                                                                                        String providerId,
                                                                                        @QueryParam(value="code")
                                                                                        String code)

getEndpoint

@Path(value="{provider_id}/endpoint")
public Object getEndpoint(@PathParam(value="provider_id")
                                                                String providerId)

retrieveTokenPreflight

@Path(value="{provider_id}/token")
 @OPTIONS
public javax.ws.rs.core.Response retrieveTokenPreflight()

retrieveToken

@GET
 @Path(value="{provider_id}/token")
public javax.ws.rs.core.Response retrieveToken(@PathParam(value="provider_id")
                                                                                        String providerId)

authenticated

public javax.ws.rs.core.Response authenticated(BrokeredIdentityContext context)

Specified by:

authenticated in interface IdentityProvider.AuthenticationCallback

validateUser

public javax.ws.rs.core.Response validateUser(UserModel user,
                                              RealmModel realm)

afterFirstBrokerLogin

@GET
 @Path(value="/after-first-broker-login")
public javax.ws.rs.core.Response afterFirstBrokerLogin(@QueryParam(value="code")
                                                                                                      String code)

afterPostBrokerLoginFlow

@GET
 @Path(value="/after-post-broker-login")
public javax.ws.rs.core.Response afterPostBrokerLoginFlow(@QueryParam(value="code")
                                                                                                        String code)

cancelled

public javax.ws.rs.core.Response cancelled(String code)

Specified by:

cancelled in interface IdentityProvider.AuthenticationCallback

error

public javax.ws.rs.core.Response error(String code,
                                       String message)

Specified by:

error in interface IdentityProvider.AuthenticationCallback

isClientSessionRegistered

protected boolean isClientSessionRegistered(String code)

Returns true if the client session is defined for the given code in the current session and for the current realm. Does not check the session validity. To obtain client session if and only if it exists and is valid, use ClientSessionCode.parse(java.lang.String, org.keycloak.models.KeycloakSession, org.keycloak.models.RealmModel).

Parameters:

code -

Returns:

browserAuthentication

protected javax.ws.rs.core.Response browserAuthentication(ClientSessionModel clientSession,
                                                          String errorMessage)

getIdentityProvider

public static IdentityProvider getIdentityProvider(KeycloakSession session,
                                                   RealmModel realm,
                                                   String alias)