-
Notifications
You must be signed in to change notification settings - Fork 215
/
PayloadMapperFactory.java
50 lines (40 loc) · 1.65 KB
/
PayloadMapperFactory.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
/*
* Copyright (c) 2022 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.connectivity.service.mapping;
import org.eclipse.ditto.internal.utils.extension.DittoExtensionPoint;
/**
* Extension for creating a {@link PayloadMapper}.
*/
public interface PayloadMapperFactory extends DittoExtensionPoint {
PayloadMapper createPayloadMapper();
String getPayloadMapperAlias();
/**
* @return {@code true} if the mapper requires mandatory {@code config} options for initialization,
* i.e. it cannot be used directly as a mapping without providing the
* {@link org.eclipse.ditto.connectivity.model.MappingContext#getOptionsAsJson()}.
*/
default boolean isConfigurationMandatory() {
return false;
}
final class ExtensionId extends DittoExtensionPoint.ExtensionId<PayloadMapperFactory> {
ExtensionId(final ExtensionIdConfig<PayloadMapperFactory> extensionIdConfig) {
super(extensionIdConfig);
}
@Override
protected String getConfigKey() {
throw new UnsupportedOperationException("PayloadMappers do not support an individual config key. " +
"They should be configured in the ditto.extensions.payload-mapper-provider.extension-config " +
"payload-mappers list.");
}
}
}