-
Notifications
You must be signed in to change notification settings - Fork 214
/
RootRouteBuilder.java
238 lines (209 loc) · 7.42 KB
/
RootRouteBuilder.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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/*
* 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.Collection;
import org.eclipse.ditto.base.model.headers.translator.HeaderTranslator;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.edge.service.headers.DittoHeadersValidator;
import org.eclipse.ditto.gateway.service.endpoints.directives.auth.GatewayAuthenticationDirective;
import org.eclipse.ditto.gateway.service.endpoints.routes.cloudevents.CloudEventsRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.connections.ConnectionsRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.devops.DevOpsRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.health.CachingHealthRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.policies.PoliciesRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.sse.SseRouteBuilder;
import org.eclipse.ditto.gateway.service.endpoints.routes.stats.StatsRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.status.OverallStatusRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.things.ThingsRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.thingsearch.ThingSearchRoute;
import org.eclipse.ditto.gateway.service.endpoints.routes.websocket.WebSocketRouteBuilder;
import org.eclipse.ditto.gateway.service.endpoints.routes.whoami.WhoamiRoute;
import org.eclipse.ditto.internal.utils.health.routes.StatusRoute;
import org.eclipse.ditto.internal.utils.protocol.ProtocolAdapterProvider;
import org.apache.pekko.http.javadsl.server.ExceptionHandler;
import org.apache.pekko.http.javadsl.server.RejectionHandler;
import org.apache.pekko.http.javadsl.server.Route;
/**
* A builder for the root {@code Route}.
*/
public interface RootRouteBuilder {
/**
* Sets the status sub-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder statusRoute(StatusRoute route);
/**
* Sets the overall status sub-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder overallStatusRoute(OverallStatusRoute route);
/**
* Sets the caching health sub-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder cachingHealthRoute(CachingHealthRoute route);
/**
* Sets the devops sub-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder devopsRoute(DevOpsRoute route);
/**
* Sets the policies sub-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder policiesRoute(PoliciesRoute route);
/**
* Sets the sse things sub-route.
*
* @param sseThingsRouteBuilder the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder sseThingsRoute(SseRouteBuilder sseThingsRouteBuilder);
/**
* Sets the things sub-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder thingsRoute(ThingsRoute route);
/**
* Sets the thing search sub-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder thingSearchRoute(ThingSearchRoute route);
/**
* Sets the connections sub-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder connectionsRoute(ConnectionsRoute route);
/**
* Sets the websocket sub-route.
*
* @param websocketRouteBuilder the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder websocketRoute(WebSocketRouteBuilder websocketRouteBuilder);
/**
* Sets the stats sub-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder statsRoute(StatsRoute route);
/**
* Sets the stats whoami-route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
* @since 1.2.0
*/
RootRouteBuilder whoamiRoute(WhoamiRoute route);
/**
* Sets the cloud events route.
*
* @param route the route to set.
* @return the Builder to allow method chaining.
* @since 1.5.0
*/
RootRouteBuilder cloudEventsRoute(CloudEventsRoute route);
/**
* Sets the http authentication directive.
*
* @param directive the directive to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder httpAuthenticationDirective(GatewayAuthenticationDirective directive);
/**
* Sets the websocket authentication directive.
*
* @param directive the directive to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder wsAuthenticationDirective(GatewayAuthenticationDirective directive);
/**
* Sets the supported API versions.
*
* @param versions the versions to set.
* @return the Builder to allow method chaining.
* @throws NullPointerException if {@code versions} is {@code null}.
*/
RootRouteBuilder supportedSchemaVersions(Collection<JsonSchemaVersion> versions);
/**
* Sets the protocol adapter provider.
*
* @param provider the provider to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder protocolAdapterProvider(ProtocolAdapterProvider provider);
/**
* Sets the header translator.
*
* @param translator the translator to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder headerTranslator(HeaderTranslator translator);
/**
* Sets the custom api routes provider.
*
* @param provider the provider to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder customApiRoutesProvider(CustomApiRoutesProvider provider, RouteBaseProperties routeBaseProperties);
/**
* Sets the custom headers handler.
*
* @param handler the handler to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder customHeadersHandler(CustomHeadersHandler handler);
/**
* Sets the exception handler.
*
* @param handler the handler to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder exceptionHandler(ExceptionHandler handler);
/**
* Sets the rejection handler.
*
* @param handler the handler to set.
* @return the Builder to allow method chaining.
*/
RootRouteBuilder rejectionHandler(RejectionHandler handler);
/**
* Sets the headers validator.
*
* @return the builder.
*/
RootRouteBuilder dittoHeadersValidator(DittoHeadersValidator dittoHeadersValidator);
/**
* Builds the root route.
*
* @return the route.
*/
Route build();
}