Package org.keycloak.services

Class ErrorResponse

java.lang.Object

org.keycloak.services.ErrorResponse

public class ErrorResponse
extends Object

Author:

Stian Thorgersen

Constructor Summary

Constructors

Constructor	Description
ErrorResponse()

Method Summary

Modifier and Type	Method	Description
static ErrorResponseException	error(String message, jakarta.ws.rs.core.Response.Status status)
static ErrorResponseException	error(String message, Object[] params, jakarta.ws.rs.core.Response.Status status)
static ErrorResponseException	error(KeycloakSession session, String locale, ModelException me, jakarta.ws.rs.core.Response.Status status)	Resolves the exception's message key using the admin theme messages and returns an error response with the localized message.
static ErrorResponseException	errors(List<ErrorRepresentation> s, jakarta.ws.rs.core.Response.Status status)
static ErrorResponseException	errors(List<ErrorRepresentation> s, jakarta.ws.rs.core.Response.Status status, boolean shrinkSingleError)
static ErrorResponseException	exists(String message)
static String	resolveMessage(KeycloakSession session, String locale, String messageKey, Object[] params)	Resolves a message key from the admin theme messages, formatting it with the supplied parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

ErrorResponse

public ErrorResponse()

Method Details

exists

public static ErrorResponseException exists(String message)

error

public static ErrorResponseException error(String message,
 jakarta.ws.rs.core.Response.Status status)

error

public static ErrorResponseException error(String message,
 Object[] params,
 jakarta.ws.rs.core.Response.Status status)

error

public static ErrorResponseException error(KeycloakSession session,
 String locale,
 ModelException me,
 jakarta.ws.rs.core.Response.Status status)

Resolves the exception's message key using the admin theme messages and returns an error response with the localized message.

resolveMessage

public static String resolveMessage(KeycloakSession session,
 String locale,
 String messageKey,
 Object[] params)

Resolves a message key from the admin theme messages, formatting it with the supplied parameters. If no translation is found, the key itself is returned as-is.

errors

public static ErrorResponseException errors(List<ErrorRepresentation> s,
 jakarta.ws.rs.core.Response.Status status)

errors

public static ErrorResponseException errors(List<ErrorRepresentation> s,
 jakarta.ws.rs.core.Response.Status status,
 boolean shrinkSingleError)