Interface IVaas

java/src/main/java/de/gdata/vaas/IVaas.java:18–222

import java.util.concurrent.CompletableFuture;

public interface IVaas {
    /**
     * Asynchronously retrieves a {@link CompletableFuture} containing the
     * {@link VaasVerdict} for the given SHA-256 hash.
     *
     * @param sha256 the SHA-256 hash to retrieve the verdict for
     * @return a {@link CompletableFuture} containing the {@link VaasVerdict} for
     * the hash
     */
    CompletableFuture<VaasVerdict> forSha256Async(Sha256 sha256);

    /**
     * Asynchronously retrieves a {@link CompletableFuture} containing the
     * {@link VaasVerdict} for the given SHA-256 hash.
     *
     * @param sha256  the SHA-256 hash to retrieve the verdict for
     * @param options The options to customize the request, such as using the cache
     *                and hash lookup. If not set the global options passed to the Vaas constructor are used.
     * @return a {@link CompletableFuture} containing the {@link VaasVerdict} for
     * the hash
     */
    CompletableFuture<VaasVerdict> forSha256Async(Sha256 sha256, ForSha256Options options);

    /**
     * Retrieves a {@link VaasVerdict} for the given SHA-256 hash.
     *
     * @param sha256 the SHA-256 hash to retrieve the verdict for
     * @return the {@link VaasVerdict} for the given SHA-256 hash
     * @throws InterruptedException        If the thread is interrupted
     * @throws VaasAuthenticationException If there is an authentication error. Don't repeat the request. Check your credentials and token endpoint.
     * @throws VaasClientException         The request is malformed or cannot be completed. Recommended actions: Don't repeat the request. Log. Analyze the error.
     * @throws VaasServerException         The server encountered an internal error. Recommended actions: You may retry the request after a certain delay. If the problem persists contact G DATA.
     */
    VaasVerdict forSha256(Sha256 sha256) throws InterruptedException, VaasAuthenticationException, VaasClientException, VaasServerException;

    /**
     * Retrieves a {@link VaasVerdict} for the given SHA-256 hash.
     *
     * @param sha256  the SHA-256 hash to retrieve the verdict for
     * @param options The options to customize the request, such as using the cache
     *                and hash lookup. If not set the global options passed to the Vaas constructor are used.
     * @return the {@link VaasVerdict} for the given SHA-256 hash
     * @throws InterruptedException        If the thread is interrupted
     * @throws VaasAuthenticationException If there is an authentication error. Don't repeat the request. Check your credentials and token endpoint.
     * @throws VaasClientException         The request is malformed or cannot be completed. Recommended actions: Don't repeat the request. Log. Analyze the error.
     * @throws VaasServerException         The server encountered an internal error. Recommended actions: You may retry the request after a certain delay. If the problem persists contact G DATA.
     */
    VaasVerdict forSha256(Sha256 sha256, ForSha256Options options)
            throws InterruptedException, VaasAuthenticationException, VaasClientException, VaasServerException;

    /**
     * Asynchronously processes a given input stream and returns a
     * {@link CompletableFuture}
     * containing the {@link VaasVerdict}.
     *
     * @param stream        the input stream to be processed
     * @param contentLength the length of the content in the input stream
     * @return a {@link CompletableFuture} containing the {@link VaasVerdict}