com.adobe.pdfservices.operation.PDFServicesJobStatusResponse 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;

import java.util.Map;

/**
 * Response object encapsulating {@link PDFServicesJob} status and retry interval.
 */
public class PDFServicesJobStatusResponse {
    private String status;

    private Map headers;


    /**
     * Constructs {@link PDFServicesJob} status response with its status, headers.
     *
     * @param status  Status of the {@link PDFServicesJob}.
     * @param headers Headers of the {@code PDFServicesResponse}.
     */
    public PDFServicesJobStatusResponse(String status, Map headers) {
        this.status = status;
        this.headers = headers;
    }


    /**
     * Returns string representation of {@link PDFServicesJobStatus} for the {@link PDFServicesJob}.
     *
     * @return string representation of {@link PDFServicesJobStatus} for the {@link PDFServicesJob}
     */
    public String getStatus() {
        return status;
    }

    /**
     * Returns retry interval for status polling of the {@link PDFServicesJob} in seconds.
     *
     * @return retry interval for status polling of the {@link PDFServicesJob} in seconds
     */
    public Integer getRetryInterval() {
        return PDFServicesJobStatus.IN_PROGRESS.getValue()
                       .equals(this.status) ? Integer.parseInt(headers.get("retry-after")) : 0;
    }
}