How to add additional info on java constraints

Question

With java validation constraints, i.e.

@NotNull, @Size, etc

You can add a message field that your api can return to the client. Is there anyway to add additional fields such as a custom code?

The problem I have is that every possible error needs it's own message and code return to the client. (By code I mean a custom one in the response body, not a http status code).

I.e.

{
  message: foo can not be null,
  code: 10001
}

The only thing I can think of is to use custom validator classes on every single field which would be quite a lot of work, or have a giant if/else block that sets the code based on the message.

Can anyone think of a nicer solution?

Thanks in advance for any help :)

How about formatting your message as "10001|foo can not be null", and then split any message you get and parse the code from the first part and the message from the second part? — RealSkeptic
– RealSkeptic, Commented Aug 3, 2016 at 13:04
That's the solution I'm currently going with. It's still not very nice. Another problem is that my error messages are in a ValidationMessages.properties file and injected as message="{Missing.foo}". To include the code in the message, the codes will also have to be in the ValidationMessages.properties file as well. Again, it's not a very nice solution. — wybourn
– wybourn, Commented Aug 3, 2016 at 13:08

Gunnar · Accepted Answer · 2016-08-09 09:54:06Z

1

You can use the payload() parameter defined by all constraint types.

You'd have to declare a class type for each one of your error codes:

public interface Error_01 {}

And then:

public class SomeValidatedClass {
    @NotNull(payload=Error_01.class)
    private String someField;
}

answered Aug 9, 2016 at 9:54

Gunnar

19.1k2 gold badges57 silver badges77 bronze badges

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

1 Comment

wybourn Over a year ago

Thanks, that looks like that might be a nicer solution.

Collectives™ on Stack Overflow

How to add additional info on java constraints

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related