org.mule.extension.api.serialization

Class EntityCollectionSuccessResponse

java.lang.Object

org.mule.extension.api.serialization.EntityCollectionSuccessResponse

All Implemented Interfaces:

CollectionSuccessResponse, SuccessResponse

public class EntityCollectionSuccessResponse
extends Object
implements CollectionSuccessResponse

Parameters used by the module to serialize a success response of entity collections.

The response is composed by a content body and a set of optional parameters to configure the serialization of the response.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
EntityCollectionSuccessResponse()
EntityCollectionSuccessResponse(org.mule.runtime.api.metadata.TypedValue<InputStream> bodyContent, org.mule.runtime.api.util.MultiMap<String,Object> flowResponseMetadataProperties, SerializationParameters serializationParameters)
EntityCollectionSuccessResponse(org.mule.runtime.api.metadata.TypedValue<InputStream> bodyContent, SerializationParameters serializationParameters)

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.metadata.TypedValue<InputStream>	getBodyContent()
org.mule.runtime.api.util.MultiMap<String,Object>	getFlowResponseMetadataProperties() Returns a map of metadata associated with the response of the flow.
org.mule.runtime.api.metadata.TypedValue<InputStream>	getResponseContent() Returns response body payload.
Optional<SerializationParameters>	getResponseParameters() Returns serialization parameters used to serialize the response.
SerializationParameters	getSerializationParameters()
boolean	isRaw() Returns true if this response has to be processed like RawEntitySuccessResponse or RawEntityCollectionSuccessResponse.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityCollectionSuccessResponse

public EntityCollectionSuccessResponse()

EntityCollectionSuccessResponse

public EntityCollectionSuccessResponse(org.mule.runtime.api.metadata.TypedValue<InputStream> bodyContent,
                                       SerializationParameters serializationParameters)

EntityCollectionSuccessResponse

public EntityCollectionSuccessResponse(org.mule.runtime.api.metadata.TypedValue<InputStream> bodyContent,
                                       org.mule.runtime.api.util.MultiMap<String,Object> flowResponseMetadataProperties,
                                       SerializationParameters serializationParameters)

Method Detail

getBodyContent

public org.mule.runtime.api.metadata.TypedValue<InputStream> getBodyContent()

getSerializationParameters

public SerializationParameters getSerializationParameters()

getResponseContent

public org.mule.runtime.api.metadata.TypedValue<InputStream> getResponseContent()

Description copied from interface: SuccessResponse

Returns response body payload.

Specified by:

getResponseContent in interface SuccessResponse

getFlowResponseMetadataProperties

public org.mule.runtime.api.util.MultiMap<String,Object> getFlowResponseMetadataProperties()

Description copied from interface: SuccessResponse

Returns a map of metadata associated with the response of the flow.

Specified by:

getFlowResponseMetadataProperties in interface SuccessResponse

isRaw

public boolean isRaw()

Description copied from interface: SuccessResponse

Returns true if this response has to be processed like RawEntitySuccessResponse or RawEntityCollectionSuccessResponse.

Specified by:

isRaw in interface SuccessResponse

getResponseParameters

public Optional<SerializationParameters> getResponseParameters()

Description copied from interface: CollectionSuccessResponse

Returns serialization parameters used to serialize the response.

Specified by:

getResponseParameters in interface CollectionSuccessResponse