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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. 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.plugins.event.carrier.restserver;
import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParameters;
import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ValidationStatus;
/**
* Apex parameters for REST as an event carrier technology with Apex as a REST client.
*
* <p>The parameters for this plugin are:
* <ol>
* <li>standalone: A flag indicating if APEX should start a standalone HTTP server to process REST requests (true) or
* whether it should use an underlying servlet infrastructure such as Apache Tomcat (False). This parameter is legal
* only on REST server event inputs.
* <li>host: The host name to use when setting up a standalone HTTP server. This parameter is legal only on REST server
* event inputs in standalone mode.
* <li>port: The port to use when setting up a standalone HTTP server. This parameter is legal only on REST server event
* inputs in standalone mode.
* </ol>
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public class RestServerCarrierTechnologyParameters extends CarrierTechnologyParameters {
// @formatter:off
private static final int MIN_USER_PORT = 1024;
private static final int MAX_USER_PORT = 65535;
/** The label of this carrier technology. */
public static final String RESTSERVER_CARRIER_TECHNOLOGY_LABEL = "RESTSERVER";
/** The producer plugin class for the REST carrier technology. */
public static final String RESTSERVER_EVENT_PRODUCER_PLUGIN_CLASS = ApexRestServerProducer.class.getName();
/** The consumer plugin class for the REST carrier technology. */
public static final String RESTSERVER_EVENT_CONSUMER_PLUGIN_CLASS = ApexRestServerConsumer.class.getName();
// REST server parameters
private boolean standalone = false;
private String host = null;
private int port = -1;
// @formatter:on
/**
* Constructor to create a REST carrier technology parameters instance and register the instance with the parameter
* service.
*/
public RestServerCarrierTechnologyParameters() {
super();
// Set the carrier technology properties for the web socket carrier technology
this.setLabel(RESTSERVER_CARRIER_TECHNOLOGY_LABEL);
this.setEventProducerPluginClass(RESTSERVER_EVENT_PRODUCER_PLUGIN_CLASS);
this.setEventConsumerPluginClass(RESTSERVER_EVENT_CONSUMER_PLUGIN_CLASS);
}
/**
* Check if the REST server is running in standalone mode or is using an underlying servlet infrastructure to manage
* requests.
*
* @return true if in standalone mode
*/
public boolean isStandalone() {
return standalone;
}
/**
* Gets the host.
*
* @return the host
*/
public String getHost() {
return host;
}
/**
* Gets the port.
*
* @return the port
*/
public int getPort() {
return port;
}
/**
* {@inheritDoc}.
*/
@Override
public GroupValidationResult validate() {
final GroupValidationResult result = super.validate();
// Check if host is defined, it is only defined on REST server consumers
if (standalone) {
if (host != null && host.trim().length() == 0) {
result.setResult("host", ValidationStatus.INVALID,
"host not specified, host must be specified as a string");
}
// Check if port is defined, it is only defined on REST server consumers
if (port != -1 && port < MIN_USER_PORT || port > MAX_USER_PORT) {
result.setResult("port", ValidationStatus.INVALID,
"[" + port + "] invalid, must be specified as 1024 <= port <= 65535");
}
} else {
if (host != null) {
result.setResult("host", ValidationStatus.INVALID, "host is specified only in standalone mode");
}
if (port != -1) {
result.setResult("port", ValidationStatus.INVALID, "port is specified only in standalone mode");
}
}
return result;
}
}
|
