-
Notifications
You must be signed in to change notification settings - Fork 214
/
CustomHeadersHandler.java
47 lines (40 loc) · 1.47 KB
/
CustomHeadersHandler.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
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.gateway.service.endpoints.routes;
import java.util.concurrent.CompletionStage;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.apache.pekko.http.javadsl.server.RequestContext;
/**
* Responsible for adding custom headers.
*/
public interface CustomHeadersHandler {
enum RequestType {
API,
WS,
SSE
}
/**
* Appends custom headers to the given default DittoHeaders and returns a new instance of DittoHeaders that
* contains both of them.
*
* @param correlationId the correlation ID.
* @param requestContext the request context.
* @param requestType the request type.
* @param dittoDefaultHeaders the headers ditto created by default.
* @return a new future instance of {@link DittoHeaders} containing both new custom headers and default headers.
*/
CompletionStage<DittoHeaders> handleCustomHeaders(CharSequence correlationId,
RequestContext requestContext,
RequestType requestType,
DittoHeaders dittoDefaultHeaders);
}