no.digipost.signature.client.direct.DirectJobStatusResponse Maven / Gradle / Ivy

Go to download
package no.digipost.signature.client.direct;

import no.digipost.signature.client.core.ConfirmationReference;
import no.digipost.signature.client.core.DeleteDocumentsUrl;
import no.digipost.signature.client.core.PAdESReference;
import no.digipost.signature.client.core.internal.Confirmable;

import java.time.Instant;
import java.util.List;

import static no.digipost.signature.client.direct.DirectJobStatus.NO_CHANGES;
import static no.digipost.signature.client.direct.Signature.signatureFrom;


public class DirectJobStatusResponse implements Confirmable {

    /**
     * This instance indicates that there has been no status updates since the last poll request for
     * {@link DirectJobStatusResponse}. Its status is {@link DirectJobStatus#NO_CHANGES NO_CHANGES}.
     */
    static DirectJobStatusResponse noUpdatedStatus(Instant nextPermittedPollTime) {
        return new DirectJobStatusResponse(null, null, NO_CHANGES, null, null, null, null, nextPermittedPollTime) {
            @Override public long getSignatureJobId() {
                throw new IllegalStateException(
                        "There were " + this + ", and querying the job ID is a programming error. " +
                        "Use the method is(" + DirectJobStatusResponse.class.getSimpleName() + "." + NO_CHANGES.name() + ") " +
                        "to check if there were any status change before attempting to get any further information.");
            }

            @Override public String toString() {
                return "no direct jobs with updated status";
            }
        };

    }

    private final Long signatureJobId;
    private final String reference;
    private final DirectJobStatus status;
    private final ConfirmationReference confirmationReference;
    private final DeleteDocumentsUrl deleteDocumentsUrl;
    private final List signatures;
    private final PAdESReference pAdESReference;
    private final Instant nextPermittedPollTime;

    public DirectJobStatusResponse(Long signatureJobId, String reference, DirectJobStatus signatureJobStatus, ConfirmationReference confirmationUrl, DeleteDocumentsUrl deleteDocumentsUrl, List signatures, PAdESReference pAdESReference, Instant nextPermittedPollTime) {
        this.signatureJobId = signatureJobId;
        this.reference = reference;
        this.status = signatureJobStatus;
        this.confirmationReference = confirmationUrl;
        this.deleteDocumentsUrl = deleteDocumentsUrl;
        this.signatures = signatures;
        this.pAdESReference = pAdESReference;
        this.nextPermittedPollTime = nextPermittedPollTime;
    }

    public long getSignatureJobId() {
        return signatureJobId;
    }

    /**
     * @return the signature job's custom reference as specified upon
     * {@link DirectJob.Builder#withReference(String) creation}. May be {@code null}.
     */
    public String getReference() {
        return reference;
    }

    public DirectJobStatus getStatus() {
        return status;
    }

    public boolean is(DirectJobStatus status) {
        return this.status == status;
    }

    public boolean isPAdESAvailable() {
        return pAdESReference != null;
    }

    public PAdESReference getpAdESUrl() {
        return pAdESReference;
    }

    public List getSignatures() {
        return signatures;
    }

    /**
     * Gets the signature from a given signer.
     *
     * @param signer a string referring to a signer of the job. It may be a personal identification number or
     *               a custom signer reference, depending of how the {@link DirectSigner signer} was initially created
     *               (using {@link DirectSigner#withPersonalIdentificationNumber(String)} or
     *               {@link DirectSigner#withCustomIdentifier(String)}).
     *
     * @throws IllegalArgumentException if the job response doesn't contain a signature from this signer
     * @see #getSignatures()
     */
    public Signature getSignatureFrom(final String signer) {
        return signatures.stream()
                .filter(signatureFrom(signer))
                .findFirst()
                .orElseThrow(() -> new IllegalArgumentException("Unable to find signature from this signer"));
    }

    /**
     * Gets the point in time where you are allowed to {@link DirectClient#getStatusChange() get status changes}.
     * 
     * Only applicable for jobs with {@link DirectJob.Builder#retrieveStatusBy(StatusRetrievalMethod) status retrieval method}
     * set to {@link StatusRetrievalMethod#POLLING POLLING}.
     *
     * @throws IllegalStateException for jobs with {@link DirectJob.Builder#retrieveStatusBy(StatusRetrievalMethod) status retrieval method}
     * not set to {@link StatusRetrievalMethod#POLLING POLLING}.
     */
    public Instant getNextPermittedPollTime() {
        if (nextPermittedPollTime == null) {
            throw new IllegalStateException("Retrieving the next permitted poll time for " + this + " is a programming error. " +
                    "This is only allowed for jobs with status retrieval method set to '" + StatusRetrievalMethod.POLLING.name() + "'.");
        }
        return nextPermittedPollTime;
    }

    @Override
    public ConfirmationReference getConfirmationReference() {
        return confirmationReference;
    }

    public DeleteDocumentsUrl getDeleteDocumentsUrl() {
        return deleteDocumentsUrl;
    }

    @Override
    public String toString() {
        return "status for direct job with ID " + signatureJobId + ": " + status;
    }

}