• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  *  http://aws.amazon.com/apache2.0
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 package software.amazon.awssdk.core.internal.http.pipeline;
17 
18 import java.util.function.BiFunction;
19 import software.amazon.awssdk.annotations.SdkInternalApi;
20 import software.amazon.awssdk.core.internal.http.RequestExecutionContext;
21 
22 /**
23  * Represents a series of transformations when executing a SDK request.
24  *
25  * @param <InputT>  Source type, provided as input param to pipeline.
26  * @param <OutputT> Output type returned by the pipeline.
27  */
28 @SdkInternalApi
29 public interface RequestPipeline<InputT, OutputT> {
30 
31     /**
32      * Execute the pipeline with the given input.
33      *
34      * @param input   Input to pipeline.
35      * @param context Context containing both request dependencies, and a container for any mutable state that must be shared
36      *                between stages.
37      * @return Output of pipeline.
38      * @throws Exception If any error occurs. This will be thrown out of the pipeline, if exceptions must be handled see
39      *                   {@link RequestPipelineBuilder#wrappedWith(BiFunction)}.
40      */
execute(InputT input, RequestExecutionContext context)41     OutputT execute(InputT input, RequestExecutionContext context) throws Exception;
42 }
43