org.bonitasoft.web.extension.rest

Interface RestApiController

public interface RestApiController

The interface to implement for Rest API extension in Bonita BPM.

Method Summary

Methods

Modifier and Type	Method and Description
RestApiResponse	doHandle(javax.servlet.http.HttpServletRequest request, RestApiResponseBuilder responseBuilder, RestAPIContext context) Let the Rest API Extension parse request for specific attribute handling.

Method Detail

doHandle

RestApiResponse doHandle(javax.servlet.http.HttpServletRequest request,
                       RestApiResponseBuilder responseBuilder,
                       RestAPIContext context)

Let the Rest API Extension parse request for specific attribute handling.

Parameters:

request - the HTTP servlet request intended to be used as in a servlet

responseBuilder - a builder for HTTP response

context - to access the current execution context data like current session,locale...

Returns:

a RestApiResponse with a body, an HTTP status and other optional http content

Since:

7.2