io.sphere.sdk.products.commands

Class ProductImageUploadCommand

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.CommandImpl<Product>

io.sphere.sdk.products.commands.ProductImageUploadCommand

All Implemented Interfaces:

SphereRequest<Product>, Command<Product>

public final class ProductImageUploadCommand
extends CommandImpl<Product>

Uploads an Image for a product.

Uploads a binary image file to a given ProductVariant. The supported image formats are JPEG, PNG and GIF.

Example usage executing the command:

withUpdateableProduct(client(),  product -> {
    final ByIdVariantIdentifier identifier = product.getMasterData().getStaged().getMasterVariant().getIdentifier();
    File imageFile ;
    try{
        imageFile = File.createTempFile("ct_logo_farbe",".gif");
        imageFile.deleteOnExit();
        byte[] fileBytes = IOUtils.toByteArray(ClassLoader.getSystemResourceAsStream("ct_logo_farbe.gif"));
        FileOutputStream outStream = new FileOutputStream(imageFile);
        outStream.write(fileBytes);
        outStream.close();
    }catch(IOException e){
        imageFile = new File("src/test/resources/ct_logo_farbe.gif");
    }

    final ProductImageUploadCommand cmd = ProductImageUploadCommand
            .ofVariantId(imageFile, identifier)
            .withFilename("logo.gif")
            .withStaged(true);
    final Product updatedProduct = client().executeBlocking(cmd);
    final Image image = updatedProduct.getMasterData().getStaged().getMasterVariant().getImages().get(0);
    assertThat(image.getDimensions().getHeight()).isEqualTo(102);
    assertThat(image.getDimensions().getWidth()).isEqualTo(460);
    assertThat(image.getUrl()).contains("logo");
    return updatedProduct;
});
See the test code.

Method Summary

Modifier and Type	Method and Description
HttpRequestIntent	httpRequestIntent() Provides an http request intent, this does not include the execution of it.
protected com.fasterxml.jackson.databind.JavaType	jacksonJavaType()
static ProductImageUploadCommand	ofMasterVariant(File body, String productId)
static ProductImageUploadCommand	ofProductIdAndSku(File body, String productId, String sku)
static ProductImageUploadCommand	ofVariantId(File body, ByIdVariantIdentifier variantIdentifier)
ProductImageUploadCommand	withContentType(String contentType) Sets the type of the Type of the uploaded image
ProductImageUploadCommand	withFilename(String newFilename)
ProductImageUploadCommand	withStaged(Boolean newStaged)

Methods inherited from class io.sphere.sdk.commands.CommandImpl

deserialize

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize

Method Detail

ofMasterVariant

public static ProductImageUploadCommand ofMasterVariant(File body,
                                                        String productId)

ofProductIdAndSku

public static ProductImageUploadCommand ofProductIdAndSku(File body,
                                                          String productId,
                                                          String sku)

ofVariantId

public static ProductImageUploadCommand ofVariantId(File body,
                                                    ByIdVariantIdentifier variantIdentifier)

withFilename

public ProductImageUploadCommand withFilename(String newFilename)

withStaged

public ProductImageUploadCommand withStaged(Boolean newStaged)

withContentType

public ProductImageUploadCommand withContentType(String contentType)

Sets the type of the Type of the uploaded image

Parameters:

contentType - must be one of "image/jpeg", "image/png" or "image/gif"

Returns:

ProductImageUploadCommand the new constructed productImageUploadCommand

jacksonJavaType

protected com.fasterxml.jackson.databind.JavaType jacksonJavaType()

Specified by:

jacksonJavaType in class CommandImpl<Product>

httpRequestIntent

public HttpRequestIntent httpRequestIntent()

Description copied from interface: SphereRequest

Provides an http request intent, this does not include the execution of it.

Returns:

http request intent