org.gcube.common.gxrest.response.outbound

Class GXOutboundSuccessResponse

java.lang.Object

org.gcube.common.gxrest.response.outbound.GXOutboundSuccessResponse

public class GXOutboundSuccessResponse
extends Object

An outbound success response message for applications.

Author:

Manuele Simi (ISTI CNR)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	build() Builds the response to return.
static GXOutboundSuccessResponse	newCREATEResponse(URI location) Builds a new response with the CREATE HTTP status.
static GXOutboundSuccessResponse	newOKResponse() Builds a new response with the OK HTTP status.
GXOutboundSuccessResponse	ofType(javax.ws.rs.core.MediaType type) Adds a type to the response message.
GXOutboundSuccessResponse	ofType(String type) Adds a type to the response message.
GXOutboundSuccessResponse	withContent(InputStream is) Reads from the stream the content to set in the response.
GXOutboundSuccessResponse	withContent(Object o) Sets the object as response's content.
GXOutboundSuccessResponse	withContent(String message) Sets the message as the response's content.

Methods inherited from class java.lang.Object

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

Method Detail

newOKResponse

public static GXOutboundSuccessResponse newOKResponse()

Builds a new response with the OK HTTP status.

Returns:

the response

newCREATEResponse

public static GXOutboundSuccessResponse newCREATEResponse(URI location)

Builds a new response with the CREATE HTTP status.

Returns:

the response

withContent

public GXOutboundSuccessResponse withContent(Object o)
                                      throws IOException

Sets the object as response's content. Any Java type instance for a response entity, that is supported by the runtime can be passed.

Parameters:

o -

Returns:

the response

Throws:

IOException

withContent

public GXOutboundSuccessResponse withContent(InputStream is)
                                      throws IOException

Reads from the stream the content to set in the response.

Parameters:

o -

Returns:

the response

Throws:

IOException

withContent

public GXOutboundSuccessResponse withContent(String message)

Sets the message as the response's content.

Parameters:

message -

Returns:

the response

ofType

public GXOutboundSuccessResponse ofType(javax.ws.rs.core.MediaType type)

Adds a type to the response message.

Parameters:

type -

Returns:

the response

ofType

public GXOutboundSuccessResponse ofType(String type)

Adds a type to the response message.

Parameters:

type -

Returns:

the response

build

public javax.ws.rs.core.Response build()

Builds the response to return.

Returns:

the response