Package com.broadleafcommerce.orderoperation.service.provider.external

Class ExternalFulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

java.lang.Object

com.broadleafcommerce.orderoperation.service.provider.external.AbstractExternalProvider

com.broadleafcommerce.orderoperation.service.provider.external.ExternalFulfillmentProvider<F>

All Implemented Interfaces:

FulfillmentProvider<F>

public class ExternalFulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>
extends AbstractExternalProvider
implements FulfillmentProvider<F>

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	BULK_REPLACE_CREATE_SEGMENT
protected static String	ORDER_CLIENT_ID	Deprecated. Use getServiceClient()
protected static String	ORDER_OWNED_FULFILLMENTS_SEGMENT

Fields inherited from class com.broadleafcommerce.orderoperation.service.provider.external.AbstractExternalProvider

RSQL_FILTER_PARAM

Constructor Summary

Constructors

Constructor	Description
ExternalFulfillmentProvider(org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ExternalOrderProperties properties)

Method Summary

Modifier and Type	Method	Description
F	create(com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Creates a OrderFulfillment.
void	delete(String fulfillmentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deletes a OrderFulfillment with the given ID.
protected org.springframework.web.util.UriComponentsBuilder	getBaseUri()	Gets the base URI common to all direct requests for fulfillments.
protected org.springframework.web.util.UriComponentsBuilder	getMatchingTenantUri()	Gets the URI for requesting a fulfillment matching tenant.
protected org.springframework.web.util.UriComponentsBuilder	getOrderOwnedBaseUri()	Gets the base URI common to requests for order-owned fulfillments.
protected ExternalOrderProperties	getProperties()
protected String	getServiceClient()
org.springframework.data.domain.Page<F>	readAll(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieve all OrderFulfillments.
List<F>	readAllByOrderId(String orderId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieve all of the OrderFulfillments with the given order ID.
F	readById(@NonNull String fulfillmentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieve the OrderFulfillment with the given ID.
F	readByIdMatchingTenant(@NonNull String fulfillmentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieve the OrderFulfillment with the given ID, ignoring its application as long as it's in the current tenant context.
F	replace(F fulfillment, String fulfillmentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Replace the OrderFulfillment with the given ID.
List<F>	replaceOrCreateAll(Collection<F> fulfillments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Replace all of the given OrderFulfillment which already exist, or create them.

Methods inherited from class com.broadleafcommerce.orderoperation.service.provider.external.AbstractExternalProvider

executeRequest, getHeaders, getObjectMapper, getTypeFactory, getWebClient, pageableToParams

Methods inherited from class java.lang.Object

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

Field Detail

BULK_REPLACE_CREATE_SEGMENT

protected static final String BULK_REPLACE_CREATE_SEGMENT

See Also:

Constant Field Values

ORDER_OWNED_FULFILLMENTS_SEGMENT

protected static final String ORDER_OWNED_FULFILLMENTS_SEGMENT

See Also:

Constant Field Values

ORDER_CLIENT_ID

@Deprecated
protected static final String ORDER_CLIENT_ID

Deprecated.

Use getServiceClient()

See Also:

Constant Field Values

Constructor Detail

ExternalFulfillmentProvider

public ExternalFulfillmentProvider(org.springframework.web.reactive.function.client.WebClient webClient,
                                   com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                   com.broadleafcommerce.common.extension.TypeFactory typeFactory,
                                   ExternalOrderProperties properties)

Method Detail

readAll

public org.springframework.data.domain.Page<F> readAll(cz.jirutka.rsql.parser.ast.Node filters,
                                                       @Nullable
                                                       org.springframework.data.domain.Pageable page,
                                                       @Nullable
                                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: FulfillmentProvider

Retrieve all OrderFulfillments.

Specified by:

readAll in interface FulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

Parameters:

filters - the list of filters to apply to this query

page - the requested page of results from the database

contextInfo - context information around sandbox and multitenant state.

Returns:

the fulfillment with the given ID

readById

public F readById(@NonNull
                  @NonNull String fulfillmentId,
                  @Nullable
                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: FulfillmentProvider

Retrieve the OrderFulfillment with the given ID.

Specified by:

readById in interface FulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

Parameters:

fulfillmentId - the ID of the fulfillment to retrieve

contextInfo - context information around sandbox and multitenant state.

Returns:

the fulfillment with the given ID

readByIdMatchingTenant

public F readByIdMatchingTenant(@NonNull
                                @NonNull String fulfillmentId,
                                @Nullable
                                com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: FulfillmentProvider

Retrieve the OrderFulfillment with the given ID, ignoring its application as long as it's in the current tenant context.

Specified by:

readByIdMatchingTenant in interface FulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

Parameters:

fulfillmentId - the ID of the fulfillment to retrieve

contextInfo - context information around sandbox and multitenant state.

Returns:

the fulfillment with the given ID

replace

public F replace(F fulfillment,
                 String fulfillmentId,
                 @Nullable
                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: FulfillmentProvider

Replace the OrderFulfillment with the given ID.

Specified by:

replace in interface FulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

Parameters:

fulfillment - the fulfillment to replace with

fulfillmentId - the ID of the fulfillment to retrieve

contextInfo - context information around sandbox and multitenant state.

Returns:

the fulfillment with the given ID

create

public F create(com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment,
                @Nullable
                com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: FulfillmentProvider

Creates a OrderFulfillment.

Specified by:

create in interface FulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

Parameters:

fulfillment - the fulfillment to create

contextInfo - context information around sandbox and multitenant state.

Returns:

the fulfillment with the given ID

delete

public void delete(String fulfillmentId,
                   @Nullable
                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: FulfillmentProvider

Deletes a OrderFulfillment with the given ID.

Specified by:

delete in interface FulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

Parameters:

fulfillmentId - the ID of the fulfillment to delete

contextInfo - context information around sandbox and multitenant state.

replaceOrCreateAll

public List<F> replaceOrCreateAll(Collection<F> fulfillments,
                                  @Nullable
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: FulfillmentProvider

Replace all of the given OrderFulfillment which already exist, or create them.

Specified by:

replaceOrCreateAll in interface FulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

Parameters:

fulfillments - the fulfillments to replace or create

contextInfo - context information around sandbox and multitenant state.

Returns:

the replaced and created fulfillments

readAllByOrderId

public List<F> readAllByOrderId(String orderId,
                                @Nullable
                                com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: FulfillmentProvider

Retrieve all of the OrderFulfillments with the given order ID.

Specified by:

readAllByOrderId in interface FulfillmentProvider<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

Parameters:

orderId - the order ID of the fulfillments to retrieve

contextInfo - context information around sandbox and multitenant state.

Returns:

the fulfillments with the given order ID

getBaseUri

protected org.springframework.web.util.UriComponentsBuilder getBaseUri()

Gets the base URI common to all direct requests for fulfillments.

Returns:

a URI components builder with the base URI set up

getMatchingTenantUri

protected org.springframework.web.util.UriComponentsBuilder getMatchingTenantUri()

Gets the URI for requesting a fulfillment matching tenant.

Returns:

a URI components builder with the fulfillment matching tenant URI

getOrderOwnedBaseUri

protected org.springframework.web.util.UriComponentsBuilder getOrderOwnedBaseUri()

Gets the base URI common to requests for order-owned fulfillments.

Returns:

a URI components builder with the base URI set up

getServiceClient

protected String getServiceClient()

getProperties

protected ExternalOrderProperties getProperties()