com.sap.smp.client.httpc.listeners

Interface IRequestBodyListener

All Known Subinterfaces:

IRequestListener

All Known Implementing Classes:

MultipartRequestFacade

public interface IRequestBodyListener

Convenience superinterface of IRequestListener containing only the method to send the request body with.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	onRequestBodySending(ITransmitEvent event) Invoked when the request body is to be sent.

Method Detail

onRequestBodySending

java.lang.Object onRequestBodySending(ITransmitEvent event)
                               throws java.io.IOException

Invoked when the request body is to be sent. Implementations can write the request body using the stream and, in case of a text-based content type, the writer. Note that the request headers are not modifiable from this method. Use the IRequestHeaderListener.onRequestHeaderSending(ISendEvent) method for that purpose.

It's an error trying to close the stream or the writer from within the implementation of this method.

Implementations are expected to monitor the return value of IBaseEvent.isCancelledExternally() and return in case it signals true. In this case the return value of this method does not count. This check can be omitted when writing to the steam or to the writer as they will monitor cancellation state on their own and throw an exception appropriately. The return value indicates cancellation by this listener. If non-null is returned then the conversation stops and the IConversationFlowListener gets invoked.

Parameters:

event - the transmission event, always non-null

Returns:

a non-null object to signal cancellation or null to allow the flow to continue. The returned value matters only in case IBaseEvent.isCancelledExternally() returns false.

Throws:

java.io.IOException - in case of problems writing to the stream/writer