org.openbaton.sdk.api.util

Class RestRequest

java.lang.Object

org.openbaton.sdk.api.util.RestRequest

Direct Known Subclasses:

AbstractRestAgent

public abstract class RestRequest
extends java.lang.Object

OpenBaton api request abstraction for all requester. Shares common data and methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseUrl
protected com.google.gson.Gson	mapper

Constructor Summary

Constructors

Constructor and Description
RestRequest(java.lang.String username, java.lang.String password, java.lang.String projectId, boolean sslEnabled, java.lang.String nfvoIp, java.lang.String nfvoPort, java.lang.String path, java.lang.String version) Create a request with a given url path

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getProjectId()
void	requestDelete(java.lang.String id) Executes a http delete with to a given id
java.lang.Object	requestGet(java.lang.String id, java.lang.Class type) Executes a http get with to a given id
protected java.lang.Object	requestGetAll(java.lang.String url, java.lang.Class type)
java.lang.Object	requestGetWithStatusAccepted(java.lang.String url, java.lang.Class type) Executes a http get with to a given url, in contrast to the normal get it uses an http (accept) status check of the response
java.io.Serializable	requestPost(java.io.Serializable object) Executes a http post with to a given url, while serializing the object content as json and returning the response
java.lang.String	requestPost(java.lang.String id) Does the POST Request
java.io.Serializable	requestPost(java.lang.String id, java.io.Serializable object)
java.io.Serializable	requestPost(java.lang.String id, java.io.Serializable object, java.lang.reflect.Type type) Executes a http post with to a given url, while serializing the object content as json.
org.openbaton.catalogue.nfvo.VNFPackage	requestPostPackage(java.io.File f) Used to upload tar files to the NFVO for creating VNFPackages.
java.io.Serializable	requestPut(java.lang.String id, java.io.Serializable object) Executes a http put with to a given id, while serializing the object content as json and returning the response
void	setProjectId(java.lang.String projectId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

baseUrl

protected final java.lang.String baseUrl

mapper

protected com.google.gson.Gson mapper

Constructor Detail

RestRequest

public RestRequest(java.lang.String username,
           java.lang.String password,
           java.lang.String projectId,
           boolean sslEnabled,
           java.lang.String nfvoIp,
           java.lang.String nfvoPort,
           java.lang.String path,
           java.lang.String version)

Create a request with a given url path

Method Detail

getProjectId

public java.lang.String getProjectId()

setProjectId

public void setProjectId(java.lang.String projectId)

requestPost

public java.lang.String requestPost(java.lang.String id)
                             throws SDKException

Does the POST Request

Parameters:

id -

Returns:

String

Throws:

SDKException

requestPost

public java.io.Serializable requestPost(java.io.Serializable object)
                                 throws SDKException

Executes a http post with to a given url, while serializing the object content as json and returning the response

Parameters:

object - the object content to be serialized as json

Returns:

a string containing the response content

Throws:

SDKException

requestPost

public java.io.Serializable requestPost(java.lang.String id,
                               java.io.Serializable object)
                                 throws SDKException

Throws:

SDKException

requestPost

public java.io.Serializable requestPost(java.lang.String id,
                               java.io.Serializable object,
                               java.lang.reflect.Type type)
                                 throws SDKException

Executes a http post with to a given url, while serializing the object content as json. The type parameter specifies to which object type the post response should be mapped before returning it. This can be useful if the method's return type is not the same as the type of the object parameter.

Parameters:

object - the object content to be serialized as json

type - the object type to which the response should be mapped

Returns:

a string containing the response content

Throws:

SDKException

requestPostPackage

public org.openbaton.catalogue.nfvo.VNFPackage requestPostPackage(java.io.File f)
                                                           throws SDKException

Used to upload tar files to the NFVO for creating VNFPackages.

Parameters:

f - the tar file containing the VNFPackage

Returns:

the created VNFPackage object

Throws:

SDKException

requestDelete

public void requestDelete(java.lang.String id)
                   throws SDKException

Executes a http delete with to a given id

Parameters:

id - the id path used for the api request

Throws:

SDKException

requestGet

public java.lang.Object requestGet(java.lang.String id,
                          java.lang.Class type)
                            throws SDKException

Executes a http get with to a given id

Parameters:

id - the id path used for the api request

Returns:

a string containing he response content

Throws:

SDKException

requestGetAll

protected java.lang.Object requestGetAll(java.lang.String url,
                             java.lang.Class type)
                                  throws SDKException

Throws:

SDKException

requestGetWithStatusAccepted

public java.lang.Object requestGetWithStatusAccepted(java.lang.String url,
                                            java.lang.Class type)
                                              throws SDKException

Executes a http get with to a given url, in contrast to the normal get it uses an http (accept) status check of the response

Parameters:

url - the url path used for the api request

Returns:

a string containing the response content

Throws:

SDKException

requestPut

public java.io.Serializable requestPut(java.lang.String id,
                              java.io.Serializable object)
                                throws SDKException

Executes a http put with to a given id, while serializing the object content as json and returning the response

Parameters:

id - the id path used for the api request

object - the object content to be serialized as json

Returns:

a string containing the response content

Throws:

SDKException