com.adobe.pdfservices.operation.pdfjobs.jobs.ExportPDFToImagesJob Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdfservices-sdk Show documentation
Adobe PDF Services SDK allows you to access RESTful APIs to create, convert, and manipulate PDFs within your applications. Older versions can be found under groupId: com.adobe.documentservices, artifactId: pdftools-sdk
There is a newer version: 4.2.0
Show newest version
/*
 * Copyright 2024 Adobe
 * All Rights Reserved.
 *
 * NOTICE: Adobe permits you to use, modify, and distribute this file in
 * accordance with the terms of the Adobe license agreement accompanying
 * it. If you have received this file from a source other than Adobe,
 * then your use, modification, or distribution of it requires the prior
 * written permission of Adobe.
 */

package com.adobe.pdfservices.operation.pdfjobs.jobs;

import com.adobe.pdfservices.operation.PDFServicesJob;
import com.adobe.pdfservices.operation.config.notifier.NotifierConfig;
import com.adobe.pdfservices.operation.exception.SDKException;
import com.adobe.pdfservices.operation.exception.ServiceApiException;
import com.adobe.pdfservices.operation.internal.ExecutionContext;
import com.adobe.pdfservices.operation.internal.PDFServicesHelper;
import com.adobe.pdfservices.operation.internal.constants.CustomErrorMessages;
import com.adobe.pdfservices.operation.internal.constants.OperationHeaderInfoEndpointMap;
import com.adobe.pdfservices.operation.internal.dto.request.PlatformApiRequest;
import com.adobe.pdfservices.operation.internal.dto.request.pdftoimages.PDFToImagesExternalAssetRequest;
import com.adobe.pdfservices.operation.internal.dto.request.pdftoimages.PDFToImagesInternalAssetRequest;
import com.adobe.pdfservices.operation.internal.http.DefaultRequestHeaders;
import com.adobe.pdfservices.operation.internal.http.HttpResponse;
import com.adobe.pdfservices.operation.internal.util.ObjectUtil;
import com.adobe.pdfservices.operation.io.Asset;
import com.adobe.pdfservices.operation.io.CloudAsset;
import com.adobe.pdfservices.operation.io.ExternalAsset;
import com.adobe.pdfservices.operation.pdfjobs.params.exportpdftoimages.ExportPDFToImagesOutputType;
import com.adobe.pdfservices.operation.pdfjobs.params.exportpdftoimages.ExportPDFToImagesParams;
import com.adobe.pdfservices.operation.pdfjobs.params.exportpdftoimages.ExportPDFToImagesTargetFormat;

import java.util.List;
import java.util.UUID;

/**
 * A job which exports a source PDF file to a supported format specified by
 * {@link ExportPDFToImagesTargetFormat}.
 * 
 * The result is a list of images or a list containing a zip of images. For example, a PDF file with 15
 * pages will generate 15 image files. The first file's name ends with "_0" and the last file's name ends with "_14".
 * 
 * Sample Usage:
 * {@code
 *             InputStream inputStream = new FileInputStream(new File("SOURCE_PATH"));
 *
 *             Credentials credentials = new ServicePrincipalCredentials(
 *                     System.getenv("PDF_SERVICES_CLIENT_ID"),
 *                     System.getenv("PDF_SERVICES_CLIENT_SECRET"));
 *
 *             PDFServices pdfServices = new PDFServices(credentials);
 *
 *             Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());
 *
 *             ExportPDFToImagesParams exportPDFToImagesParams = ExportPDFToImagesParams.exportPDFToImagesParamsBuilder(
 *                             ExportPDFToImagesTargetFormat.JPEG, ExportPDFToImagesOutputType.LIST_OF_PAGE_IMAGES).build();
 *             ExportPDFToImagesJob exportPDFToImagesJob = new ExportPDFToImagesJob(asset, exportPDFToImagesParams);
 *
 *             String location = pdfServices.submit(exportPDFToImagesJob);
 *             PDFServicesResponse pdfServicesResponse = pdfServices.getJobResult(location, ExportPDFToImagesResult.class);
 *
 *             List resultAssets = pdfServicesResponse.getResult().getAssets();
 *
 *             int index = 0;
 *             for (Asset resultAsset : resultAssets) {
 *                 StreamAsset streamAsset = pdfServices.getContent(resultAsset);
 *                 index++;
 *             }
 * }
 */
public class ExportPDFToImagesJob extends PDFServicesJob {
    private Asset inputAsset;
    private Asset outputAsset;
    private ExportPDFToImagesParams exportPDFToImagesParams;


    /**
     * Constructs a new {@code ExportPDFToImagesJob} instance.
     *
     * @param asset                   {@link Asset} object containing the input file; can not be null.
     * @param exportPDFToImagesParams {@link ExportPDFToImagesParams} object containing the export to images
     *                                parameters; can not be null.
     */
    public ExportPDFToImagesJob(Asset asset, ExportPDFToImagesParams exportPDFToImagesParams) {
        ObjectUtil.requireNonNull(asset, String.format(CustomErrorMessages.GENERIC_CAN_NOT_BE_NULL, "Input Asset"));
        ObjectUtil.requireNonNull(exportPDFToImagesParams, String.format(CustomErrorMessages.GENERIC_CAN_NOT_BE_NULL,
                "Export PDF To Images parameters"));
        this.inputAsset = asset;
        this.exportPDFToImagesParams = exportPDFToImagesParams;
    }

    @Override
    protected String process(ExecutionContext executionContext) throws ServiceApiException {
        return this.process(executionContext, null);
    }

    @Override
    protected String process(ExecutionContext executionContext, List notifyConfigList) throws ServiceApiException {
        this.validate(executionContext);

        if (ExportPDFToImagesOutputType.LIST_OF_PAGE_IMAGES.equals(this.exportPDFToImagesParams.getExportPDFToImagesOutputType()) && this.inputAsset instanceof ExternalAsset) {
            throw new SDKException("Please select Output Type as zip of pages for external storage.");
        }

        PlatformApiRequest exportPDFToImagesRequest = generatePlatformApiRequest(notifyConfigList);
        String xRequestId = UUID.randomUUID().toString();
        HttpResponse response = PDFServicesHelper.submitJob(executionContext, exportPDFToImagesRequest,
                xRequestId,
                OperationHeaderInfoEndpointMap.EXPORT_PDF_TO_IMAGES);
        return response.getHeaders().get(DefaultRequestHeaders.LOCATION_HEADER_NAME);
    }

    /**
     * Sets the output asset for the job.
     * {@code @note} External assets can be set as output only when input is external asset as well
     *
     * @param asset {@link Asset} object representing the output asset; can not be null.
     * @return {@code ExportPDFToImagesJob} instance
     */
    public ExportPDFToImagesJob setOutput(Asset asset) {
        ObjectUtil.requireNonNull(asset, String.format(CustomErrorMessages.GENERIC_CAN_NOT_BE_NULL, "Output asset"));
        if (this.inputAsset instanceof CloudAsset) {
            throw new IllegalArgumentException(CustomErrorMessages.SET_OUTPUT_VALIDATE);
        }

        this.outputAsset = asset;
        return this;
    }


    private PlatformApiRequest generatePlatformApiRequest(List notifyConfigList) {
        PlatformApiRequest exportPDFToImagesRequest;
        if (this.inputAsset instanceof CloudAsset) {
            exportPDFToImagesRequest =
                    new PDFToImagesInternalAssetRequest(( (CloudAsset) this.inputAsset ).getAssetId(),
                            this.exportPDFToImagesParams, notifyConfigList);
        } else {
            exportPDFToImagesRequest = new PDFToImagesExternalAssetRequest((ExternalAsset) this.inputAsset,
                    this.exportPDFToImagesParams,
                    notifyConfigList).setOutput((ExternalAsset) outputAsset);
        }
        return exportPDFToImagesRequest;
    }
}