com.hcl.voltmx.commons.annotations

Annotation Type OnException

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface OnException

Use this annotation to mark a method as exception handler in DataPostProcessor and DataPostProcessor2 classes. If DataPreProcessor or DataPreProcessor2 or the actual back-end service call throws an exception, then the DataPostProcessor.execute and DataPostProcessor2.execute methods are not called, instead method annotated with the below type is called.

The exception handler method could have any of below optional parameters in any order -

• The exception that occurred, of type Exception, annotated with VoltmxException
• The client request, of type DataControllerRequest, annotated with VoltmxContext
• The client response to send, of type DataControllerResponse, annotated with VoltmxContext
• The map of all inputs coming from client, of type Map, annotated with VoltmxContext
• The result of execution that will be sent to client, of type Result, annotated with VoltmxContext

For example -

 
    @OnException
    public Result onError(@VoltmxContext Result result, @VoltmxContext DataControllerRequest request,
            @VoltmxContext DataControllerResponse response, @VoltmxException Exception exception) {
        // Do your custom error handling...
        return result;
    }
 
 

See Also:

DataPreProcessor, DataPreProcessor2, DataPostProcessor, DataPostProcessor2, Result, DataControllerRequest, DataControllerResponse, VoltmxContext, VoltmxException