com.ibm.cloud.objectstorage.protocol.json.internal

Class JsonProtocolMarshaller<OrigRequest>

java.lang.Object

com.ibm.cloud.objectstorage.protocol.json.internal.JsonProtocolMarshaller<OrigRequest>

Type Parameters:

OrigRequest - Type of the original request object.

All Implemented Interfaces:

ProtocolMarshaller, ProtocolRequestMarshaller<OrigRequest>

public class JsonProtocolMarshaller<OrigRequest>
extends Object
implements ProtocolRequestMarshaller<OrigRequest>

Implementation of ProtocolMarshaller for JSON based services. This includes JSON-RPC and REST-JSON.

Constructor Summary

Constructors

Constructor and Description
JsonProtocolMarshaller(StructuredJsonGenerator jsonGenerator, String contentType, OperationInfo operationInfo, OrigRequest originalRequest, MarshallerRegistry.Builder marshallerRegistryOverrides, EmptyBodyJsonMarshaller emptyBodyMarshaller)

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.
<V> void	marshall(V val, MarshallingInfo<V> marshallingInfo) Marshalls the value into the appropriate location based on the MarshallingInfo metadata.
void	startMarshalling() If there is not an explicit payload member then we need to start the implicit JSON request object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonProtocolMarshaller

public JsonProtocolMarshaller(StructuredJsonGenerator jsonGenerator,
                              String contentType,
                              OperationInfo operationInfo,
                              OrigRequest originalRequest,
                              MarshallerRegistry.Builder marshallerRegistryOverrides,
                              EmptyBodyJsonMarshaller emptyBodyMarshaller)

Method Detail

startMarshalling

public void startMarshalling()

If there is not an explicit payload member then we need to start the implicit JSON request object. All members bound to the payload will be added as fields to this object.

Specified by:

startMarshalling in interface ProtocolRequestMarshaller<OrigRequest>

marshall

public <V> void marshall(V val,
                         MarshallingInfo<V> marshallingInfo)

Description copied from interface: ProtocolMarshaller

Marshalls the value into the appropriate location based on the MarshallingInfo metadata.

Specified by:

marshall in interface ProtocolMarshaller

Parameters:

val - Value to marshall. May be null if the location allows it (for example, members bound to the path must never be null or empty).

marshallingInfo - Metadata about how and where to marshall the data. Must not be null.

finishMarshalling

public Request<OrigRequest> finishMarshalling()

Description copied from interface: ProtocolRequestMarshaller

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

Specified by:

finishMarshalling in interface ProtocolRequestMarshaller<OrigRequest>

Returns:

Marshalled Request object.