com.mulesoft.connectors.dynamics365bc.citizen.internal.builder

Class SidecarRequestBuilder

java.lang.Object

com.mulesoft.connectors.dynamics365bc.citizen.internal.builder.SidecarRequestBuilder

public class SidecarRequestBuilder
extends Object

Simplify building complex Dynamics Business Central requests for Composer

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.metadata.TypedValue<InputStream>	build(com.mulesoft.connectors.dynamics365bc.internal.connection.MicrosoftRestConnection connection) Uses DataWeave to convert the request from a Java Map to a valid JSON InputStream
static SidecarRequestBuilder	builder() Use to retrieve the builder object in a readable way
SidecarRequestBuilder	withParam(String paramName, Object value) Add a single Key-Value pair to the payload.
<T> SidecarRequestBuilder	withUnpacked(String prefix, Object object, Class<T> clazz) Unpacks the fields of another object and adds them to the request body in the form of: prefix{FieldName} = {fieldValue} This way you can simplify adding entire parameter groups to the request with a single line.

Methods inherited from class java.lang.Object

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

Method Detail

withParam

public SidecarRequestBuilder withParam(String paramName,
                                       Object value)

Add a single Key-Value pair to the payload. If the value is null the pair is automatically ignored. To un-set a field in Business Central set it to an empty string ""

Parameters:

paramName - - Name of the parameter to add

value - - Value of the parameter

Returns:

The root builder

withUnpacked

public <T> SidecarRequestBuilder withUnpacked(String prefix,
                                              Object object,
                                              Class<T> clazz)

Unpacks the fields of another object and adds them to the request body in the form of: prefix{FieldName} = {fieldValue} This way you can simplify adding entire parameter groups to the request with a single line.

Type Parameters:

T - - the type of the group object

Parameters:

prefix - - the prefix to prepend to each field name

object - - the parameter group object to unpack

clazz - - the class of the parameter group object (required because Mule packs ParameterGroups as Proxy objects, which disrupts the usage of getClass())

Returns:

the root builder

build

public org.mule.runtime.api.metadata.TypedValue<InputStream> build(com.mulesoft.connectors.dynamics365bc.internal.connection.MicrosoftRestConnection connection)

Uses DataWeave to convert the request from a Java Map to a valid JSON InputStream

Parameters:

connection - the connection to use when applying expressions

Returns:

the resulting TypedValue

builder

public static SidecarRequestBuilder builder()

Use to retrieve the builder object in a readable way

Returns:

constructs a new builder