org.openecomp.sdc.common.rest.api

Interface IRestClient

All Known Implementing Classes:

HttpRestClientServiceImpl

public interface IRestClient

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

Method Summary

Modifier and Type	Method and Description
void	destroy() destroy the connections
RestResponse	doDELETE(String uri, Properties headers) This method will return resource according to the given URI.
RestResponse	doGET(String uri, Properties headers) This method will return resource according to the given URI.
RestResponse	doPOST(String uri, Properties headers, Object objectToCreate) This method will CREATE resource according to the given URI.
RestResponse	doPUT(String uri, Properties headers, Object objectToUpdate) This method will UPDATE resource according to the given URI.
boolean	init() initialize the rest client instance.
boolean	init(RestConfigurationInfo restConfigurationInfo) initialize the rest client instance with a given timeout in milliseconds.

Method Detail

doGET

RestResponse doGET(String uri,
                   Properties headers)

This method will return resource according to the given URI.

Parameters:

uri - Full URL path to the desire resource.

headers - - list of headers in format of name and value, to be add as part of the HTTP request.

Returns:

JSON representation of the requested resource.

doPOST

RestResponse doPOST(String uri,
                    Properties headers,
                    Object objectToCreate)

This method will CREATE resource according to the given URI.

Parameters:

uri - Full URL path to the desire resource.

headers - - list of headers in format of name and value, to be add as part of the HTTP request.

objectToCreate - - JSON representation of the resource.

doPUT

RestResponse doPUT(String uri,
                   Properties headers,
                   Object objectToUpdate)

This method will UPDATE resource according to the given URI.

Parameters:

uri - Full URL path to the desire resource.

headers - - list of headers in format of name and value, to be add as part of the HTTP request.

objectToUpdate - - JSON representation of the resource.

doDELETE

RestResponse doDELETE(String uri,
                      Properties headers)

This method will return resource according to the given URI.

Parameters:

uri - Full URL path to the desire resource.

headers - - list of headers in format of name and value, to be add as part of the HTTP request.

init

boolean init()
      throws Exception

initialize the rest client instance. The timeout is infinite.

Throws:

Exception

init

boolean init(RestConfigurationInfo restConfigurationInfo)

initialize the rest client instance with a given timeout in milliseconds.

Parameters:

restConfigurationInfo -

destroy

void destroy()

destroy the connections