Package org.keycloak.common.util

Class ResponseSessionTask

java.lang.Object

org.keycloak.common.util.ResponseSessionTask

All Implemented Interfaces:

KeycloakSessionTaskWithResult<jakarta.ws.rs.core.Response>

public abstract class ResponseSessionTask
extends Object
implements KeycloakSessionTaskWithResult<jakarta.ws.rs.core.Response>

A KeycloakSessionTaskWithResult that is aimed to be used by endpoints that want to produce a Response in a retriable transaction. It takes care of the boilerplate code that is common to be seen in this scenario, allowing the endpoint to focus on the actual code that has to be executed in a retriable manner.

More specifically, this task:

pushes the task's session into the resteasy context, restoring the original value after the task is over. This allows for endpoints to create new instances of themselves and inject the resteasy properties correctly;

sets up the task's session context, based on model values found in the original session's context;

handles WebApplicationException when it is thrown by the task.

Author:

Stefan Guilhen

Constructor Summary

Constructors

Constructor	Description
ResponseSessionTask(KeycloakSession originalSession)	Constructs a new instance of this task.

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	run(KeycloakSession session)	Computes a result.
abstract jakarta.ws.rs.core.Response	runInternal(KeycloakSession session)	Builds the response that is to be returned.

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseSessionTask

public ResponseSessionTask(KeycloakSession originalSession)

Constructs a new instance of this task.

Parameters:

originalSession - the original KeycloakSession that was active when the task was created.

Method Details

run

public jakarta.ws.rs.core.Response run(KeycloakSession session)

Description copied from interface: KeycloakSessionTaskWithResult

Computes a result.

Specified by:

run in interface KeycloakSessionTaskWithResult<jakarta.ws.rs.core.Response>

Parameters:

session - a reference to the KeycloakSession.

Returns:

the computed result.

runInternal

public abstract jakarta.ws.rs.core.Response runInternal(KeycloakSession session)

Builds the response that is to be returned.

Parameters:

session - a reference the KeycloakSession.

Returns:

the constructed Response.