info.freelibrary.vertx.s3.AwsSignature Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-s3-service Show documentation

An S3 client library for the Vert.x toolkit

There is a newer version: 2.0.0-alpha-2


package info.freelibrary.vertx.s3;

import io.vertx.core.Future;
import io.vertx.core.MultiMap;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.file.AsyncFile;

/**
 * An AWS authentication signature.
 */
public interface AwsSignature {

    /**
     * Gets the authentication value from the signature. This value can then be put into an "Authentication"
     * header in the S3 request.
     *
     * @param aHeaders HttpHeaders for a request being sent to S3
     * @param aMethod The method of the request being sent to S3
     * @param aPayload The payload to be signed
     * @return The authentication string
     */
    Future getAuthorization(MultiMap aHeaders, String aMethod, Buffer aPayload);

    /**
     * Gets the authentication value from the signature. This value can then be put into an "Authentication"
     * header in the S3 request.
     *
     * @param aHeaders HttpHeaders for a request being sent to S3
     * @param aMethod The method of the request being sent to S3
     * @param aPayload The payload to be signed
     * @return The authentication string
     */
    Future getAuthorization(MultiMap aHeaders, String aMethod, AsyncFile aPayload);

    /**
     * Gets the authentication value from the signature. This value can then be put into an "Authentication"
     * header in the S3 request.
     *
     * @param aHeaders HttpHeaders for a request being sent to S3
     * @param aMethod The method of the request being sent to S3
     * @param aPayload The payload to be signed
     * @return The authentication string
     */
    Future getAuthorization(MultiMap aHeaders, String aMethod, String aPayload);
}