How to POST REST correct error status code using Spring Exception handling

Question

I'm trying to handle missing json data in a POST request. My controller class

@Controller
@RequestMapping("/testMetrics")

public class TestMetricsEndPoint extends StatusEndpointHandler implements RestEndPoint<TestMetrics,String> {

@Autowired
private ObjectMapper mapper;

@Autowired
private TestMetricsService testMetricsService;

@Override
public Status get(String id) {
    // TODO Auto-generated method stub
    return null;
}


@Override
@RequestMapping(method = RequestMethod.POST,consumes = "application/json", produces = "application/json")
public @ResponseBody Status create(@RequestBody TestMetrics core, BindingResult bindingResult) {
    try {
    if(bindingResult.hasErrors()){
        throw new InvalidRequestException("Add failed, Please try again ", bindingResult);
    }
    if((core.getGroupName()==""||core.getGroupName()==null)&&(core.getTestName()==null||core.getTestName()=="")){

            throw new MissingParametersException(HttpStatus.BAD_REQUEST.value(),"Please provide all necessary parameters");
        } 
    TestMetrics dataObject = testMetricsService.create(core);
    return response(HttpStatus.CREATED.value(),dataObject);
    }catch (MissingParametersException e) {
        return             response(HttpStatus.BAD_REQUEST.value(),e.getLocalizedMessage());
    }

}

Extended class:

public class StatusEndpointHandler {


public Status response(Integer statusCode,Object data){
    Status status = new Status();
    status.setData(data);
    status.setStatus(statusCode);



    return status;
}

}

Implemented interface:

 public interface RestEndPoint<T extends SynRestBaseJSON, ID extends    Serializable> {

Status get(ID id);

Status create(T entity, BindingResult bindingResult);}

Result:

Please look at the highlighted part So, when i tried to test the result through POSTMAN, i'm getting status as 200 OK. I have no idea hot to solve it. please help me with this situation. How to get the correct status code.?

Master Slave · Accepted Answer · 2016-07-15 05:06:48Z

1

You should change your return type from @ResponseBody to ResponseEntity which will allow you to manipulate headers, therefor set the status, this is a snippet from the docs

 @RequestMapping("/handle")
 public ResponseEntity<String> handle() {
   URI location = ...;
   HttpHeaders responseHeaders = new HttpHeaders();
   responseHeaders.setLocation(location);
   responseHeaders.set("MyResponseHeader", "MyValue");
   return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED);
 }

edited Jul 15, 2016 at 5:06

answered Jul 15, 2016 at 4:57

Master Slave

28.6k4 gold badges61 silver badges56 bronze badges

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

2 Comments

krish Over a year ago

Sorry, I'm not clear about what you said. I understood that i need to use @ResponseEntity. But, i did not get how to use it.

Master Slave Over a year ago

I nearly hinted it as a right way to go. You should find plenty of resources to understand why, and how to use it. Basically, its the built-in class that is logic equivalent to your StatusEndpointHandler

Community · Accepted Answer · 2017-05-23 11:51:26Z

1

In your catch statement, try to set the status through

response.setStatus( HttpServletResponse.SC_BAD_REQUEST  );

Source

edited May 23, 2017 at 11:51

CommunityBot

11 silver badge

answered Jul 15, 2016 at 5:20

Luke Russert

313 bronze badges

Comments

Saravana · Accepted Answer · 2016-07-15 07:33:37Z

0

The problem is with your code handing the string comparison, to compare strings you have to use equals, from Postman also you are passing empty testName and groupName

    if ((core.getGroupName() == "" || core.getGroupName() == null) && (core.getTestName() == null || core.getTestName() == "")) {
    }

so change your code to below

    if ((core.getGroupName() == null || core.getGroupName().trim().isEmpty()) && (core.getTestName() == null || core.getTestName().trim().isEmpty())) {

    }

also write an ExceptionHandler for this

@ExceptionHandler({ MissingParametersException.class })
public ModelAndView handleException(ServiceException ex, HttpServletResponse response) {
    response.setStatus(HttpStatus.BAD_REQUEST.value());
    ModelMap model = new ModelMap();
    model.addAttribute("message", ex.getMessage());
    return new ModelAndView("error", model);
}

You can also define validation constrains in entity class using validation api, in this case you need to add @Valid to the request model object

@Entity
class TestMetrics {

    @Id
    Long id;

    @NotNull
    @NotEmpty
    @Column
    String groupName;

    @NotNull
    @NotEmpty
    @Column
    String testName;

    // Getters and Setters

}

edited Jul 15, 2016 at 7:33

answered Jul 15, 2016 at 5:07

Saravana

12.8k2 gold badges42 silver badges60 bronze badges

4 Comments

Saravana Over a year ago

have you entered testName and groupName ? it should not be empty or null as per the validation logic

krish Over a year ago

Yes. I entered bot of them

Saravana Over a year ago

could you post testName and groupName values inside the method create

Saravana Over a year ago

updated code with exception handler, have a look at it

Collectives™ on Stack Overflow

How to POST REST correct error status code using Spring Exception handling

3 Answers 3

2 Comments

Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related