com.ibm.cloud.objectstorage.protocol

Interface ProtocolRequestMarshaller<OrigRequest>

Type Parameters:

OrigRequest - Type of the original request object.

All Superinterfaces:

ProtocolMarshaller

All Known Implementing Classes:

JsonProtocolMarshaller

public interface ProtocolRequestMarshaller<OrigRequest>
extends ProtocolMarshaller

Interface used by generated marshallers to transform a Java POJO in a Request object which represents an HTTP request.

Example Usage:

 
 ProtocolRequestMarshaller<FooRequest> = createProtocolMarshaller(...);
 protocolMarshaller.startMarshalling();
 protocolMarshaller.marshall(obj, marshallingInfo);
 Request<FooRequest> marshalledRequest = protocolMarshaller.finishMarshalling();
 
 

Method Summary

Modifier and Type	Method and Description
Request<OrigRequest>	finishMarshalling() Finializes the marshalling and produces a Request object that can be sent for execution.
void	startMarshalling() Hook to perform an initialization that needs to happen at the start of marshalling.

Methods inherited from interface com.ibm.cloud.objectstorage.protocol.ProtocolMarshaller

marshall

Method Detail

startMarshalling

void startMarshalling()

Hook to perform an initialization that needs to happen at the start of marshalling. Must be called before any call to ProtocolMarshaller.marshall(Object, MarshallingInfo).

finishMarshalling

Request<OrigRequest> finishMarshalling()

Finializes the marshalling and produces a Request object that can be sent for execution. Must be the last method called in the marshaller.

Returns:

Marshalled Request object.