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
|
/*-
* ============LICENSE_START=======================================================
* SDC
* ================================================================================
* Copyright (C) 2017 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.openecomp.sdc.common.rest.api;
import java.util.Properties;
/**
* This interface describe the methods of the REST generic client. Each method
* will receive the destination URI and specific list of headers. With this
* information the REST Client will create a request to the specific REST Web
* server. Error from the REST Web server will be return by proprietary
* exception object.
*
* @author esofer
*
*/
public interface IRestClient {
/**
* This method will return resource according to the given URI.
*
* @param uri
* Full URL path to the desire resource.
* @param headers
* - list of headers in format of name and value, to be add as
* part of the HTTP request.
* @return JSON representation of the requested resource.
*/
public RestResponse doGET(String uri, Properties headers);
/**
* This method will CREATE resource according to the given URI.
*
* @param uri
* Full URL path to the desire resource.
* @param headers
* - list of headers in format of name and value, to be add as
* part of the HTTP request.
* @param objectToCreate
* - JSON representation of the resource.
*/
public RestResponse doPOST(String uri, Properties headers, Object objectToCreate);
/**
* This method will UPDATE resource according to the given URI.
*
* @param uri
* Full URL path to the desire resource.
* @param headers
* - list of headers in format of name and value, to be add as
* part of the HTTP request.
* @param objectToUpdate
* - JSON representation of the resource.
*/
public RestResponse doPUT(String uri, Properties headers, Object objectToUpdate);
/**
* This method will return resource according to the given URI.
*
* @param uri
* Full URL path to the desire resource.
* @param headers
* - list of headers in format of name and value, to be add as
* part of the HTTP request.
*
*/
public RestResponse doDELETE(String uri, Properties headers);
/**
* initialize the rest client instance. The timeout is infinite.
*/
public boolean init() throws Exception;
/**
* initialize the rest client instance with a given timeout in milliseconds.
*
* @param restConfigurationInfo
*/
public boolean init(RestConfigurationInfo restConfigurationInfo);
/**
* destroy the connections
*/
public void destroy();
}
|
