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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2017-2019 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.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.common.endpoints.http.client;
import java.util.Map;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Response;
import org.onap.policy.common.capabilities.Startable;
/**
* Http Client interface.
*/
public interface HttpClient extends Startable {
/**
* GET request.
*
* @param path context uri path.
* @return response
*/
Response get(String path);
/**
* GET request.
*
* @return response
*/
Response get();
/**
* PUT request.
*
* @param path context uri path
* @param entity body
* @param headers headers
*
* @return response.
*/
Response put(String path, Entity<?> entity, Map<String, Object> headers);
/**
* POST request.
*
* @param path context uri path
* @param entity body
* @param headers headers
*
* @return response.
*/
Response post(String path, Entity<?> entity, Map<String, Object> headers);
/**
* DELETE request.
*
* @param path context uri path
* @param headers headers
*
* @return response.
*/
Response delete(String path, Map<String, Object> headers);
/**
* Retrieve the body from the HTTP transaction.
*
* @param response response.
* @param entityType body type.
* @param <T> body class.
*
* @return response.
*/
static <T> T getBody(Response response, Class<T> entityType) {
return response.readEntity(entityType);
}
/**
* Get the client name.
* @return name
*/
String getName();
/**
* HTTPS support.
*
* @return if the client uses https
*/
boolean isHttps();
/**
* Self-signed certificates.
*
* @return if the self-signed certificates are allowed
*/
boolean isSelfSignedCerts();
/**
* Get the host name.
*
* @return host name
*/
String getHostname();
/**
* Get the port.
*
* @return port
*/
int getPort();
/**
* Get the base path.
*
* @return base path
*/
String getBasePath();
/**
* Get the user name.
*
* @return the user name
*/
String getUserName();
/**
* Get the password.
*
* @return the password
*/
String getPassword();
/**
* Get the base URL.
*
* @return the base URL
*/
String getBaseUrl();
}
|
