org.pipservices.rpc.services

Class HttpResponseSender

java.lang.Object

org.pipservices.rpc.services.HttpResponseSender

public class HttpResponseSender
extends Object

Helper class that handles HTTP-based responses.

Constructor Summary

Constructors

Constructor and Description
HttpResponseSender()

Method Summary

Modifier and Type	Method and Description
static javax.ws.rs.core.Response	sendCreatedResult(Object result) Creates a callback function that sends newly created object as JSON.
static javax.ws.rs.core.Response	sendDeletedResult(Object result) Creates a callback function that sends deleted object as JSON.
static javax.ws.rs.core.Response	sendEmptyResult() Creates a callback function that sends an empty result with 204 status code.
static javax.ws.rs.core.Response	sendError(Exception ex) Sends error serialized as ErrorDescription object and appropriate HTTP status code.
static javax.ws.rs.core.Response	sendResult(Object result) Creates a callback function that sends result as JSON object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpResponseSender

public HttpResponseSender()

Method Detail

sendError

public static javax.ws.rs.core.Response sendError(Exception ex)

Sends error serialized as ErrorDescription object and appropriate HTTP status code. If status code is not defined, it uses 500 status code.

Parameters:

ex - an error object to be sent.

Returns:

HTTP response status

sendResult

public static javax.ws.rs.core.Response sendResult(Object result)

Creates a callback function that sends result as JSON object. That callack function call be called directly or passed as a parameter to business logic components. If object is not null it returns 200 status code. For null results it returns 204 status code. If error occur it sends ErrorDescription with approproate status code.

Parameters:

result - a body object to result.

Returns:

execution result.

sendEmptyResult

public static javax.ws.rs.core.Response sendEmptyResult()

Creates a callback function that sends an empty result with 204 status code. If error occur it sends ErrorDescription with approproate status code.

Returns:

HTTP response status with no content.

sendCreatedResult

public static javax.ws.rs.core.Response sendCreatedResult(Object result)

Creates a callback function that sends newly created object as JSON. That callack function call be called directly or passed as a parameter to business logic components. If object is not null it returns 201 status code. For null results it returns 204 status code. If error occur it sends ErrorDescription with approproate status code.

Parameters:

result - a body object to created result

Returns:

execution result.

sendDeletedResult

public static javax.ws.rs.core.Response sendDeletedResult(Object result)

Creates a callback function that sends deleted object as JSON. That callack function call be called directly or passed as a parameter to business logic components. If object is not null it returns 200 status code. For null results it returns 204 status code. If error occur it sends ErrorDescription with approproate status code.

Parameters:

result - a body object to deleted result

Returns:

execution result.