Spring controller enum request validation

Question

I have a simple spring rest controller that looks like this.

@RestController
public class MyController {

@RequestMapping(path = "mapping", method = RequestMethod.POST, produces = {"application/json"})
    public MyResponse create(@RequestBody MyModel requestParam
    ) throws InvalidApplicationSentException, AuthenticationFailedException {
 // method body
}

Here is the MyModel class that's used as a request parameter.

public class MyModel {
    private RequestType requestType;
    // a lot of other properties ..
}

Now when i try to call this endpoint passing an invalid value for RequestType I get back an exeption:

org.springframework.http.converter.HttpMessageNotReadableException
Could not read document: Can not construct instance of com.mypackage.RequestType from String value 'UNDEFINED': value not one of declared Enum instance names: [IMPROTANT, NOT_IMPORTANT]

Is there a way that spring would set the enum to null when passed incorrect value and not throw an error?

I'm using spring 4 and I would prefer configuration with annotations and not xml files

bvrakvs · Accepted Answer · 2017-01-31 00:42:57Z

3

You need to implement a custom JSON serialization method in your enum class http://chrisjordan.ca/post/50865405944/custom-json-serialization-for-enums-using-jackson

Use @JsonCreator in your enum and on null or undefined value just return null to get going.

@JsonCreator
public static RequestType create(String value) {
    if(value == null) {
        return null;
    }
    for(RequestType v : values()) {
        if(value.equals(v.getName())) {
            return v;
        }
    }
    return null;
}

edited Jan 31, 2017 at 0:42

bvrakvs

14.7k4 gold badges55 silver badges96 bronze badges

answered Nov 16, 2016 at 9:49

ScanQR

3,8202 gold badges16 silver badges34 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Spring controller enum request validation

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related