summaryrefslogtreecommitdiffstats
path: root/common/src/main/java/org/onap/so/rest/service/HttpRestServiceProvider.java
blob: 282c87a73664154a7c928bed80cdd126697ca628 (plain)
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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 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.so.rest.service;

import org.springframework.http.ResponseEntity;

import com.google.common.base.Optional;

/**
 * @author waqas.ikram@est.tech
 */
public interface HttpRestServiceProvider {

    /**
     * Execute the HTTP GET to the given URI template
     * 
     * @param url the URL
     * @param clazz the type of the return value
     * @return Returns the body of this entity.
     */
    public <T> Optional<T> get(final String url, final Class<T> clazz);

    /**
     * Execute the HTTP GET to the given URI template
     * 
     * @param url the URL
     * @param clazz the type of the return value
     * @return Returns the {@link ResponseEntity}.
     */
    public <T> ResponseEntity<T> getHttpResponse(final String url, final Class<T> clazz);


    /**
     * Execute the HTTP POST to the given URI template
     * 
     * @param object the entity (i.e. body) to write to the request
     * @param url the URL
     * @param clazz the type of the return value
     * @return Returns the body of this entity.
     */
    public <T> Optional<T> post(final Object object, final String url, final Class<T> clazz);

    /**
     * Execute the HTTP POST to the given URI template
     * 
     * @param object the entity (i.e. body) to write to the request
     * @param url the URL
     * @param clazz the type of the return value
     * @return Returns the {@link ResponseEntity}.
     */
    public <T> ResponseEntity<T> postHttpRequest(final Object object, final String url, final Class<T> clazz);

  /**
   * Execute the HTTP DELETE to the given URI template
   *
   * @param url the URL
   * @param clazz the type of the return value
   * @return Returns the {@link ResponseEntity}.
   */
  public <T> ResponseEntity<T> deleteHttpRequest(final String url, final Class<T> clazz);


}