com.konylabs.middleware.api

Interface ServiceRequest

public interface ServiceRequest

The service request interface.

Since:

Fabric V8 SP2 (8.2)

Method Summary

Modifier and Type	Method and Description
org.apache.http.entity.BufferedHttpEntity	invokePassThroughServiceAndGetEntity() Invokes a response pass through enabled services and returns the BufferedHttpEntity which will contain backend response.
<R> R	invokePassThroughServiceAndGetEntity(Function<InputStream,R> typeParser) Invokes a response pass through enabled service.
void	invokeService(BiConsumer<DataControllerRequest,DataControllerResponse> responseConsumer) Invokes a response pass through enabled service.
String	invokeServiceAndGetJson() Invokes the service and returns middleware response as JSON String.
Result	invokeServiceAndGetResult() Invokes the service and returns middleware response as Result object.

Method Detail

invokeServiceAndGetJson

String invokeServiceAndGetJson()
                        throws MiddlewareException

Invokes the service and returns middleware response as JSON String. When an exception is thrown, the result will be added as an attribute to the request object provided to the service request builder. It can be access as request.getAttribute(MWConstants.CHUNKED_RESULTS_IN_JSON) which will return JSON string

Returns:

middleware response JSON as a string

Throws:

MiddlewareException

invokePassThroughServiceAndGetEntity

org.apache.http.entity.BufferedHttpEntity invokePassThroughServiceAndGetEntity()
                                                                        throws MiddlewareException

Invokes a response pass through enabled services and returns the BufferedHttpEntity which will contain backend response.

Returns:

BufferedHttpEntity that will contain the data received from backend

Throws:

MiddlewareException

invokePassThroughServiceAndGetEntity

<R> R invokePassThroughServiceAndGetEntity(Function<InputStream,R> typeParser)
                                    throws MiddlewareException

Invokes a response pass through enabled service. This method will use the TypeParser passed to it to parse the actual InputStream response from the pass through service and return the response.

Parameters:

typeParser - The type parser to be used where R is the type of response to be returned

Returns:

Converted object based on TypeParser

Throws:

MiddlewareException

invokeServiceAndGetResult

Result invokeServiceAndGetResult()
                          throws MiddlewareException

Invokes the service and returns middleware response as Result object. When an exception is thrown, the result will be added as an attribute to the request object provided to the service request builder. It can be access as request.getAttribute(MWConstants.RESULTS) which will return result object.

Returns:

Middleware Result object for the service invoked

Throws:

MiddlewareException

See Also:

Result

invokeService

void invokeService(BiConsumer<DataControllerRequest,DataControllerResponse> responseConsumer)
            throws MiddlewareException

Invokes a response pass through enabled service. This method will use the TypeParser passed to it to parse the actual InputStream response from the pass through service and return the response.

Parameters:

responseConsumer - The response consumer

Throws:

MiddlewareException

NullPointerException