Package com.alpermulayim.openfoodfacts_spring_boot_starter

Class OpenFoodFactsWebClient

java.lang.Object

com.alpermulayim.openfoodfacts_spring_boot_starter.OpenFoodFactsWebClient

All Implemented Interfaces:

OpenFoodFactsApi

@Service("openFoodFactsWebClient")
public class OpenFoodFactsWebClient
extends Object
implements OpenFoodFactsApi

OpenFoodFactsWebClient designed to simplify the integration of OpenFoodFacts REST APIs into Spring Boot applications. Developers can easily connect to the OpenFoodFacts API without implement any complex RESTFul calls.

Author:

Alper Mulayim https://github.com/AlperMulayim

Constructor Summary

Constructors

Constructor	Description
OpenFoodFactsWebClient(OpenFoodFactsWebClientProperties clientProperties)	Constructor for OpenFoodFactsWebClient.OpenFoodFactsWebClientProperties.

Method Summary

Modifier and Type	Method	Description
OpenPriceFactsResponse	findPrice(PriceRequest priceRequest)	Searches for product prices based on a PriceRequest.
OpenPriceFactsResponse	findPrice(String productCode)	Finds price details for a product.
OpenFoodFactsResponse	getProduct(ProductRequest request)	Retrieves product details using a ProductRequest.
OpenFoodFactsResponse	getProduct(String productCode)	Retrieves product details.
OpenFoodFactsResponse	getProduct(String productCode, List<ProductField> fields)	Retrieve Product with setted fields.
ProductSaveResponse	saveProduct(ProductSaveRequest request)	Saves new product or updates product information.
OpenFoodFactsPageResponse	searchProduct(ProductSearchRequest request)	Searches for products based on a ProductSearchRequest.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<String>>	uploadProductImage(ProductImageUploadRequest request)	Uploads a product image asynchronously.
String	uploadProductImageBlocked(ProductImageUploadRequest request)	Uploads a product image synchronously.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<String>>	uploadProductImageUnblocked(ProductImageUploadRequest request)	Uploads a product image asynchronously.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenFoodFactsWebClient

@Autowired
public OpenFoodFactsWebClient(OpenFoodFactsWebClientProperties clientProperties)

Constructor for OpenFoodFactsWebClient.OpenFoodFactsWebClientProperties.

Parameters:

clientProperties - Configuration properties for the API.

Method Details

getProduct

public OpenFoodFactsResponse getProduct(String productCode,
 List<ProductField> fields)

Retrieve Product with setted fields.

Specified by:

getProduct in interface OpenFoodFactsApi

Parameters:

productCode - product code

fields - the retrieved fields list on response object.ProductField.

Returns:

The product details wrapped in an OpenFoodFactsResponse.

Throws:

OpenFoodFactsException - if the product code is null or empty.

getProduct

public OpenFoodFactsResponse getProduct(String productCode)

Retrieves product details.

Specified by:

getProduct in interface OpenFoodFactsApi

Parameters:

productCode - product code

Returns:

The product details wrapped in an OpenFoodFactsResponse.

getProduct

public OpenFoodFactsResponse getProduct(ProductRequest request)

Retrieves product details using a ProductRequest.

Specified by:

getProduct in interface OpenFoodFactsApi

Parameters:

request - The request object containing productCode and fields.

Returns:

The product details wrapped in an OpenFoodFactsResponse.

Throws:

OpenFoodFactsException - if request or required fields are null.

searchProduct

public OpenFoodFactsPageResponse searchProduct(ProductSearchRequest request)
                                        throws InvocationTargetException,
IllegalAccessException,
OpenFoodFactsException

Searches for products based on a ProductSearchRequest.

Specified by:

searchProduct in interface OpenFoodFactsApi

Parameters:

request - The search request containing query parameters.

Returns:

The paginated response wrapped in an OpenFoodFactsPageResponse.

Throws:

OpenFoodFactsException - if request is null.

InvocationTargetException

IllegalAccessException

findPrice

public OpenPriceFactsResponse findPrice(String productCode)
                                 throws OpenFoodFactsException

Finds price details for a product.

Specified by:

findPrice in interface OpenFoodFactsApi

Parameters:

productCode - product code

Returns:

The price details wrapped in an OpenPriceFactsResponse.

Throws:

OpenFoodFactsException - if the product code is null or empty.

findPrice

public OpenPriceFactsResponse findPrice(PriceRequest priceRequest)
                                 throws OpenFoodFactsException

Searches for product prices based on a PriceRequest.

Specified by:

findPrice in interface OpenFoodFactsApi

Parameters:

priceRequest - product code

Returns:

The price details wrapped in an OpenPriceFactsResponse.

Throws:

OpenFoodFactsException - if the product code is null or empty.

uploadProductImage

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<String>> uploadProductImage(ProductImageUploadRequest request)

Uploads a product image asynchronously.

Specified by:

uploadProductImage in interface OpenFoodFactsApi

Parameters:

request - The image upload ProductImageUploadRequest. request containing image data.

Returns:

A Mono with the server response.

uploadProductImageUnblocked

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<String>> uploadProductImageUnblocked(ProductImageUploadRequest request)
                                                                                                         throws OpenFoodFactsException

Uploads a product image asynchronously.

Specified by:

uploadProductImageUnblocked in interface OpenFoodFactsApi

Parameters:

request - The image upload ProductImageUploadRequest. request containing image data.

Returns:

A Mono with the server response.

Throws:

OpenFoodFactsException

uploadProductImageBlocked

public String uploadProductImageBlocked(ProductImageUploadRequest request)
                                 throws OpenFoodFactsException

Uploads a product image synchronously.

Specified by:

uploadProductImageBlocked in interface OpenFoodFactsApi

Parameters:

request - The image upload request containing image data. ProductImageUploadRequest.

Returns:

server response.

Throws:

OpenFoodFactsException

saveProduct

public ProductSaveResponse saveProduct(ProductSaveRequest request)
                                throws OpenFoodFactsException

Saves new product or updates product information.

Specified by:

saveProduct in interface OpenFoodFactsApi

Parameters:

request - The product save new product or update product request. ProductSaveRequest.

Returns:

The saved product response wrapped in a ProductSaveResponse.

Throws:

OpenFoodFactsException - if request is null or missing required fields.