nl.vpro.nep.service.NEPGatekeeperService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of media-nep Show documentation

Support for the several APIs of NEP that POMS is integrating with

There is a newer version: 8.3.1

package nl.vpro.nep.service;

import java.io.IOException;
import java.time.Instant;
import java.util.Iterator;
import java.util.Optional;

import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

import nl.vpro.nep.domain.workflow.*;
import nl.vpro.nep.service.exception.NEPException;

/**
 * This is an interface for the NEP 'transcode' API. This used to be WorkflowExecutionService.
 * 
 * api docs
 *
 * @author Michiel Meeuwissen
 * @since 5.6
 */
public interface NEPGatekeeperService extends  AutoCloseable {

    @NonNull
    WorkflowExecution transcode(
        @NonNull WorkflowExecutionRequest request
    ) throws IOException;

    @NonNull
    Iterator getTranscodeStatuses(
        @Nullable String mid,
        @Nullable StatusType status,
        @Nullable Instant from,
        @Nullable Long limit
    ) throws NEPException;

    @NonNull
    Optional getTranscodeStatus(
        @NonNull String workflowId
    ) throws NEPException;

    String getGatekeeperString();
}