Aller au contenu

$response.sendError

Description

Retourne une erreur dans la réponse. La méthode permet de lier un message à l'erreur, mais la prise en compte de ce dernier est fortement dépendant du serveur d'application sur lequel le moteur est lancé.

$response.setStatus versus $response.sendError

La méthode $response.setStatus permet également de signaler un code d'erreur HTTP, mais le principe de fonctionnement est légèrement différent. En effet, $response.setStatus ne fait que de modifier le statut de la réponse, alors que $response.sendError retourne explicitement une erreur. Si le fichier web.xml définit des éléments du genre 

<error-page>
    <error-code>500</error-code>
    <location>/error500.jsp</location>
</error-page>

ces derniers ne seront pas pris en considération si le statut de la réponse est simplement modifié par $response.setStatus, alors qu'ils le seront avec l'usage de $response.sendError.

En résumé:

  • on utilisera $response.sendError lorsque l'on souhaite générer un code d'erreur et profiter des pages d'erreur pré-définies dans le web.xml.
  • on utilisera $response.setStatus lorsque l'on souhaite générer une réponse avec un statut spécifique et un payload personnalisé

Syntaxe

$response.sendError( status [ , message ] )

Paramètres

status number
Statut HTTP sous forme d'entier
message number

Message à associer à l'erreur

La prise en compte de ce paramètre est au bon vouloir du serveur d'application.

Retour

Retourne toujours null

Exemple

1
$response.sendError(400);