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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2019-2020 Nordix Foundation.
* ================================================================================
* 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.restrequestor;
import java.util.regex.Matcher;
import lombok.Getter;
import lombok.Setter;
import org.onap.policy.apex.service.parameters.carriertechnology.RestPluginCarrierTechnologyParameters;
import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ValidationStatus;
// @formatter:off
/**
* Apex parameters for REST as an event carrier technology with Apex issuing a REST request and receiving a REST
* response.
*
* <p>The parameters for this plugin are:
* <ol>
* <li>url: The URL that the Apex Rest Requestor will connect to over REST for REST request sending.
* This parameter is mandatory.
* <li>httpMethod: The HTTP method to use when making requests over REST, legal values are GET (default),
* POST, PUT, and DELETE.
* <li>httpHeaders, the HTTP headers to send on REST requests, optional parameter, defaults to none.
* <li>httpCodeFilter: a regular expression filter for returned HTTP codes, if the returned HTTP code passes this
* filter, then the request is assumed to have succeeded by the plugin, optional, defaults to allowing 2xx codes
* through, that is a regular expression of "[2][0-9][0-9]"
* </ol>
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
//@formatter:on
@Getter
@Setter
public class RestRequestorCarrierTechnologyParameters extends RestPluginCarrierTechnologyParameters {
/** The default HTTP method for request events. */
public static final HttpMethod DEFAULT_REQUESTOR_HTTP_METHOD = HttpMethod.GET;
/** The default timeout for REST requests. */
public static final long DEFAULT_REST_REQUEST_TIMEOUT = 500;
/**
* Constructor to create a REST carrier technology parameters instance and register the instance with the parameter
* service.
*/
public RestRequestorCarrierTechnologyParameters() {
super();
// Set the carrier technology properties for the REST requestor carrier technology
this.setLabel("RESTREQUESTOR");
this.setEventProducerPluginClass(ApexRestRequestorProducer.class.getName());
this.setEventConsumerPluginClass(ApexRestRequestorConsumer.class.getName());
}
// @formatter:off
/**
* Validate the URL.
*
* <p>Checks:
* http://www.blah.com/{par1/somethingelse (Missing end tag) use {[^\\{}]*$
* http://www.blah.com/{par1/{some}thingelse (Nested tag) use {[^}]*{
* http://www.blah.com/{par1}/some}thingelse (Missing start tag1) use }[^{}]*.}
* http://www.blah.com/par1}/somethingelse (Missing start tag2) use }[^{}]*}
* http://www.blah.com/{}/somethingelse (Empty tag) use {[\s]*}
* @param result the result of the validation
*/
// @formatter:on
@Override
public GroupValidationResult validateUrl(final GroupValidationResult result) {
// URL is only set on Requestor consumers
if (getUrl() == null) {
return result;
}
Matcher matcher = patternErrorKey.matcher(getUrl());
if (matcher.find()) {
result.setResult("url", ValidationStatus.INVALID,
"no proper URL has been set for event sending on REST requestor");
}
return result;
}
}
|
