Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ThrowError mediator docs #1224

Merged
merged 8 commits into from
Jan 6, 2025
6 changes: 6 additions & 0 deletions en/docs/reference/mediators/about-mediators.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,12 @@ WSO2 Micro Integrator includes a comprehensive catalog of mediators that provide
</td>
<td>Content-aware</td>
</tr>
<tr>
<td>
<a href="{{base_path}}/reference/mediators/throw-error-mediator">ThrowError mediator</a>
</td>
<td>Conditionally content-aware</td>
</tr>
<tr>
<td>
<a href="{{base_path}}/reference/mediators/callout-mediator">Callout mediator</a>
Expand Down
64 changes: 64 additions & 0 deletions en/docs/reference/mediators/throw-error-mediator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# ThrowError Mediator

The ThrowError mediator allows you to raise an error from the mediation sequence. The error type and message can be customized as required.
GDLMadushanka marked this conversation as resolved.
Show resolved Hide resolved

!!! Info
Errors thrown by the ThrowError mediator is handled by the onError sequence (if defined) or the default fault sequence.

## Syntax

``` java
<!-- Error message as string -->
<throw-error type="string" errorMessage="string"></throw-error>
<!-- Dynamic error message -->
<throw-error type="string" errorMessage="{string}"></throw-error>
```

## Examples

Following examples demonstrate the use of Throw Error mediator.
DinithiDiaz marked this conversation as resolved.
Show resolved Hide resolved

### Example 1
DinithiDiaz marked this conversation as resolved.
Show resolved Hide resolved

The following API configuration demonstrates how to use the Throw Error mediator to raise an error when some required field is not present in the incoming payload.
DinithiDiaz marked this conversation as resolved.
Show resolved Hide resolved

``` xml
<?xml version="1.0" encoding="UTF-8"?>
<api context="/testThrowError" name="TestThrowErrorMediatorAPI" xmlns="http://ws.apache.org/ns/synapse">
<resource methods="POST">
<inSequence>
<filter xpath="${exists(payload.required)}">
<then>
<log level="full"/>
<respond/>
</then>
<else>
<variable name="ERROR_MSG" value="Required field does not exist"/>
<throwError type="PAYLOAD_ERROR" errorMessage="{${var.ERROR_MSG}}"/>
</else>
</filter>
</inSequence>
<faultSequence>
<log level="custom">
<property name="ERROR_CODE" expression="get-property('ERROR_CODE')"/>
<property name="ERROR_MESSAGE" expression="get-property('ERROR_MESSAGE')"/>
</log>
<drop/>
</faultSequence>
</resource>
</api>
```

Invoking the above API with a payload that does not contain the required field will raise an error.
DinithiDiaz marked this conversation as resolved.
Show resolved Hide resolved
```
curl --location 'http://localhost:8290/testThrowError' \
--header 'Content-Type: application/json' \
--data '{
"Hello": "World"
}'
```

Response log will contain the error message as follows.
DinithiDiaz marked this conversation as resolved.
Show resolved Hide resolved
```
INFO {LogMediator} - {api:TestThrowErrorMediatorAPI} ERROR_CODE = PAYLOAD_ERROR, ERROR_MESSAGE = Required field does not exist
```
1 change: 1 addition & 0 deletions en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,7 @@ nav:
- Store Mediator: reference/mediators/store-mediator.md
- Switch Mediator: reference/mediators/switch-mediator.md
- Throttle Mediator: reference/mediators/throttle-mediator.md
- ThrowError Mediator: reference/mediators/throw-error-mediator.md
- Transaction Mediator: reference/mediators/transaction-mediator.md
- URLRewrite Mediator: reference/mediators/urlrewrite-mediator.md
- Validate Mediator: reference/mediators/validate-mediator.md
Expand Down