commonMain.aws.smithy.kotlin.runtime.http.operation.OperationMiddleware.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-client-jvm Show documentation

HTTP client abstractions

The newest version!

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package aws.smithy.kotlin.runtime.http.operation

import aws.smithy.kotlin.runtime.InternalApi
import aws.smithy.kotlin.runtime.http.HttpCall
import aws.smithy.kotlin.runtime.io.middleware.Middleware
import aws.smithy.kotlin.runtime.io.middleware.ModifyRequest

/**
 * Middleware that intercepts the [SdkOperationExecution.initialize] phase
 */
@InternalApi
public interface InitializeMiddleware : Middleware, Response> {
    @InternalApi
    public fun install(op: SdkHttpOperation) {
        op.execution.initialize.register(this)
    }
}

/**
 * Middleware that intercepts the [SdkOperationExecution.mutate] phase
 */
@InternalApi
public interface MutateMiddleware : Middleware {
    @InternalApi
    public fun install(op: SdkHttpOperation<*, Response>) {
        op.execution.mutate.register(this)
    }
}

/**
 * A middleware that only mutates the outgoing [SdkHttpRequest].
 *
 * NOTE: This can be applied to any phase that uses [SdkHttpRequest] as it's input type
 * (e.g. mutate, onEachAttempt, receive)
 */
@InternalApi
public interface ModifyRequestMiddleware : ModifyRequest {
    /**
     * Register this transform with the operation's execution
     *
     * NOTE: the default implementation will register with the [SdkOperationExecution.mutate] phase.
     */
    @InternalApi
    public fun install(op: SdkHttpOperation<*, *>) {
        op.execution.mutate.register(this)
    }
}

/**
 * Middleware that intercepts the [SdkOperationExecution.receive] phase
 */
@InternalApi
public interface ReceiveMiddleware : Middleware {
    @InternalApi
    public fun install(op: SdkHttpOperation<*, *>) {
        op.execution.receive.register(this)
    }
}

/**
 * A middleware that directly registers interceptors onto an operation inline in install.
 * This can be useful for example if a middleware needs to hook into multiple phases:
 *
 * ```
 * class MyMiddleware : InlineMiddleware {
 *     override fun install(op: SdkHttpOperation) {
 *         op.execution.initialize.intercept { req, next -> ... }
 *
 *         op.execution.mutate.intercept { req, next -> ... }
 *     }
 * }
 *
 * ```
 */
@InternalApi
public interface InlineMiddleware {
    public fun install(op: SdkHttpOperation)
}