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
135
|
/*-
* ============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.restrequestor;
import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParameters;
/**
* Apex parameters for REST as an event carrier technology with Apex issuing a REST request and receiving a REST
* response.
*
* 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>restRequestTimeout: The time in milliseconds to wait for a REST request to complete.
* </ol>
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public class RESTRequestorCarrierTechnologyParameters extends CarrierTechnologyParameters {
/** The supported HTTP methods. */
public enum HTTP_METHOD {
GET, PUT, POST, DELETE
}
/** The label of this carrier technology. */
public static final String RESTREQUESTOR_CARRIER_TECHNOLOGY_LABEL = "RESTREQUESTOR";
/** The producer plugin class for the REST carrier technology. */
public static final String RESTREQUSTOR_EVENT_PRODUCER_PLUGIN_CLASS =
ApexRestRequestorProducer.class.getCanonicalName();
/** The consumer plugin class for the REST carrier technology. */
public static final String RESTREQUSTOR_EVENT_CONSUMER_PLUGIN_CLASS =
ApexRestRequestorConsumer.class.getCanonicalName();
/** The default HTTP method for request events. */
public static final HTTP_METHOD DEFAULT_REQUESTOR_HTTP_METHOD = HTTP_METHOD.GET;
/** The default timeout for REST requests. */
public static final long DEFAULT_REST_REQUEST_TIMEOUT = 500;
private String url = null;
private HTTP_METHOD httpMethod = null;
/**
* Constructor to create a REST carrier technology parameters instance and register the instance with the parameter
* service.
*/
public RESTRequestorCarrierTechnologyParameters() {
super(RESTRequestorCarrierTechnologyParameters.class.getCanonicalName());
// Set the carrier technology properties for the web socket carrier technology
this.setLabel(RESTREQUESTOR_CARRIER_TECHNOLOGY_LABEL);
this.setEventProducerPluginClass(RESTREQUSTOR_EVENT_PRODUCER_PLUGIN_CLASS);
this.setEventConsumerPluginClass(RESTREQUSTOR_EVENT_CONSUMER_PLUGIN_CLASS);
}
/**
* Gets the URL for the REST request.
*
* @return the URL
*/
public String getURL() {
return url;
}
/**
* Sets the URL for the REST request.
*
* @param incomingURL the URL
*/
public void setURL(final String incomingURL) {
this.url = incomingURL;
}
/**
* Gets the HTTP method to use for the REST request.
*
* @return the HTTP method
*/
public HTTP_METHOD getHttpMethod() {
return httpMethod;
}
/**
* Sets the HTTP method to use for the REST request.
*
* @param httpMethod the HTTP method
*/
public void setHttpMethod(final HTTP_METHOD httpMethod) {
this.httpMethod = httpMethod;
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return "RESTRequestorCarrierTechnologyParameters [url=" + url + ", httpMethod=" + httpMethod + "]";
}
/*
* (non-Javadoc)
*
* @see org.onap.policy.apex.apps.uservice.parameters.ApexParameterValidator#validate()
*/
@Override
public String validate() {
return "";
}
}
|
