/
ConnectivityConfigProvider.java
71 lines (61 loc) · 2.67 KB
/
ConnectivityConfigProvider.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
/*
* Copyright (c) 2020 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.services.connectivity.config;
import java.util.concurrent.CompletionStage;
import org.atteo.classindex.IndexSubclasses;
import org.eclipse.ditto.model.base.headers.DittoHeaders;
import org.eclipse.ditto.model.connectivity.ConnectionId;
import akka.actor.ActorRef;
/**
* Provides methods to load {@link ConnectivityConfig} and register for changes to {@link ConnectivityConfig}.
*/
@IndexSubclasses
public interface ConnectivityConfigProvider {
/**
* Loads a {@link ConnectivityConfig} by a connection ID.
*
* @param connectionId the connection id for which to load the {@link ConnectivityConfig}
* @return the connectivity config
*/
ConnectivityConfig getConnectivityConfig(ConnectionId connectionId);
/**
* Asynchronously loads a {@link ConnectivityConfig} by a connection ID.
*
* @param connectionId the connection id for which to load the {@link ConnectivityConfig}
* @return the connectivity config
*/
CompletionStage<ConnectivityConfig> getConnectivityConfigAsync(ConnectionId connectionId);
/**
* Loads a {@link ConnectivityConfig} by some ditto headers.
*
* @param dittoHeaders the ditto headers for which to load the {@link ConnectivityConfig}
* @return the connectivity config
*/
ConnectivityConfig getConnectivityConfig(DittoHeaders dittoHeaders);
/**
* Asynchronously loads a {@link ConnectivityConfig} by some ditto headers.
*
* @param dittoHeaders the ditto headers for which to load the {@link ConnectivityConfig}
* @return the connectivity config
*/
CompletionStage<ConnectivityConfig> getConnectivityConfigAsync(DittoHeaders dittoHeaders);
/**
* Register the given {@code subscriber} for changes to the {@link ConnectivityConfig} of the given {@code
* connectionId}. The given {@link ActorRef} will receive {@link ConnectivityConfigBuildable} to build the final
* {@link ConnectivityConfig} given a default/fallback {@link ConnectivityConfig}.
*
* @param connectionId the connection id
* @param subscriber the subscriber that will receive {@link ConnectivityConfigBuildable} messages
*/
void registerForConnectivityConfigChanges(final ConnectionId connectionId, final ActorRef subscriber);
}