-
Notifications
You must be signed in to change notification settings - Fork 180
/
HttpDeserializer.java
53 lines (48 loc) · 2.35 KB
/
HttpDeserializer.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*
* Copyright © 2018 Apple Inc. and the ServiceTalk project authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.servicetalk.http.api;
import io.servicetalk.buffer.api.Buffer;
import io.servicetalk.concurrent.BlockingIterable;
import io.servicetalk.concurrent.api.Publisher;
/**
* A factory to address deserialization concerns for HTTP request/response payload bodies.
* @param <T> The type of objects to deserialize.
*/
public interface HttpDeserializer<T> {
/**
* Deserialize a single {@link Object} into a {@link T}.
* @param headers The {@link HttpHeaders} associated with the {@code payload}.
* @param payload The {@link Object} to deserialize. The contents are assumed to be in memory, otherwise this method
* may block.
* @return The result of the deserialization.
*/
T deserialize(HttpHeaders headers, Buffer payload);
/**
* Deserialize a {@link BlockingIterable} of {@link Object}s into a {@link BlockingIterable} of type {@link T}.
* @param headers The {@link HttpHeaders} associated with the {@code payload}.
* @param payload Provides the {@link Object}s to deserialize. The contents are assumed to be in memory, otherwise
* this method may block.
* @return a {@link BlockingIterable} of type {@link T} which is the result of the deserialization.
*/
BlockingIterable<T> deserialize(HttpHeaders headers, BlockingIterable<Buffer> payload);
/**
* Deserialize a {@link Publisher} of {@link Object}s into a {@link Publisher} of type {@link T}.
* @param headers The {@link HttpHeaders} associated with the {@code payload}.
* @param payload Provides the {@link Object}s to deserialize.
* @return a {@link Publisher} of type {@link T} which is the result of the deserialization.
*/
Publisher<T> deserialize(HttpHeaders headers, Publisher<Buffer> payload);
}