blob: 51e9b6d4036f70fa9cd0b5119bfa726b37bcbb5b (
plain)
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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.apex.service.engine.event.impl.jsonprotocolplugin;
import lombok.Getter;
import lombok.Setter;
import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolTextCharDelimitedParameters;
// @formatter:off
/**
* Event protocol parameters for JSON as an event protocol.
*
* <p>The parameters for this plugin are:
* <ol>
* <li>nameAlias: The field in a JSON event to use as an alias for the event name. This parameter is
* optional.
* <li>versionAlias: The field in a JSON event to use as an alias for the event version. This
* parameter is optional.
* <li>nameSpaceAlias: The field in a JSON event to use as an alias for the event name space. This
* parameter is optional.
* <li>sourceAlias: The field in a JSON event to use as an alias for the event source. This
* parameter is optional.
* <li>targetAlias: The field in a JSON event to use as an alias for the event target. This
* parameter is optional.
* <li>pojoField: The event is received and sent as a single POJO using the event field
* definition in this field name in the schema, there must be one and only one field in the
* event definition, the event has a single parameter whose type is the Pojo. This parameter is optional.
* </ol>
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
//@formatter:on
@Getter
@Setter
public class JsonEventProtocolParameters extends EventProtocolTextCharDelimitedParameters {
/** The label of this event protocol. */
public static final String JSON_EVENT_PROTOCOL_LABEL = "JSON";
// Constants for text block delimiters
private static final char JSON_TEXT_BLOCK_START_DELIMITER = '{';
private static final char JSON_TEXT_BLOCK_END_DELIMITER = '}';
// Aliases for Apex event header fields
// @formatter:off
private String nameAlias = null;
private String versionAlias = null;
private String nameSpaceAlias = null;
private String sourceAlias = null;
private String targetAlias = null;
// @formatter:on
// Flag indicating POJO decoding and encoding and parameter indicating the name of the Pojo field
private String pojoField = null;
/**
* Constructor to create a JSON event protocol parameter instance and register the instance with the parameter
* service.
*/
public JsonEventProtocolParameters() {
this(JSON_EVENT_PROTOCOL_LABEL);
}
/**
* Constructor to create an event protocol parameters instance with the name of a sub class of this class.
* @param eventProtocolLabel the name of the event protocol for this plugin
*/
public JsonEventProtocolParameters(final String eventProtocolLabel) {
super();
// Set the event protocol properties for the JSON event protocol
this.setLabel(eventProtocolLabel);
// Set the starting and ending delimiters for text blocks of JSON events
this.setStartChar(JSON_TEXT_BLOCK_START_DELIMITER);
this.setEndChar(JSON_TEXT_BLOCK_END_DELIMITER);
// Set the event protocol plugin class
this.setEventProtocolPluginClass(Apex2JsonEventConverter.class.getName());
}
/**
* {@inheritDoc}.
*/
@Override
public String getName() {
return this.getLabel();
}
}
|
