-
Notifications
You must be signed in to change notification settings - Fork 215
/
CustomApiRoutesProvider.java
67 lines (58 loc) · 2.58 KB
/
CustomApiRoutesProvider.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
/*
* 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 org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.service.DittoExtensionPoint;
import org.eclipse.ditto.gateway.service.util.config.DittoGatewayConfig;
import org.eclipse.ditto.internal.utils.config.DefaultScopedConfig;
import akka.actor.ActorSystem;
import akka.http.javadsl.server.Route;
/**
* Provider for custom routes.
* You can distinguish between routes for unauthorized access and authorized access.
*/
public abstract class CustomApiRoutesProvider extends DittoExtensionPoint {
protected CustomApiRoutesProvider(final ActorSystem actorSystem) {
super(actorSystem);
}
/**
* Provides a custom route for unauthorized access.
*
* @param routeBaseProperties the basic properties of the root route.
* @param version the API version.
* @param correlationId the correlation ID.
* @return custom route for unauthorized access.
*/
public abstract Route unauthorized(RouteBaseProperties routeBaseProperties, JsonSchemaVersion version,
CharSequence correlationId);
/**
* Provides a custom route for authorized access.
*
* @param routeBaseProperties the basic properties of the root route.
* @param headers headers of the request.
* @return custom route for authorized access.
*/
public abstract Route authorized(RouteBaseProperties routeBaseProperties, DittoHeaders headers);
/**
* Loads the implementation of {@code CustomApiRoutesProvider} which is configured for the {@code ActorSystem}.
*
* @param actorSystem the actorSystem in which the {@code CustomApiRoutesProvider} should be loaded.
* @return the {@code CustomApiRoutesProvider} implementation.
*/
public static CustomApiRoutesProvider get(final ActorSystem actorSystem) {
final var implementation = DittoGatewayConfig.of(DefaultScopedConfig.dittoScoped(
actorSystem.settings().config())).getHttpConfig().getCustomApiRoutesProvider();
return new ExtensionId<>(implementation, CustomApiRoutesProvider.class).get(actorSystem);
}
}