utility

Class DefaultRestApiHelper

java.lang.Object

utility.RestApiHelper

utility.DefaultRestApiHelper

public class DefaultRestApiHelper
extends RestApiHelper

REST API helper functions.

Constructor Summary

Constructors

Constructor and Description
DefaultRestApiHelper()

Method Summary

Modifier and Type	Method and Description
static org.apache.http.client.HttpClient	createHttpClient(java.lang.String username, java.lang.String password) Create an HTTP client to connect to REST API server.
static org.apache.http.client.methods.HttpGet	getRequest(org.apache.http.client.HttpClient httpClient, java.lang.String uri) Get an http request.
static org.apache.http.HttpResponse	getResponse(org.apache.http.client.methods.HttpGet httpRequest, org.apache.http.client.HttpClient httpClient) Execute a http request to get a HTTP response.
static void	httpClientShutDown(org.apache.http.client.HttpClient httpClient) Shut down http client connection.
static void	httpDelRequest(org.apache.http.client.HttpClient httpClient, java.lang.String uri)
static java.io.BufferedReader	httpPostRequest(org.apache.http.client.HttpClient httpClient, java.lang.String uri, org.apache.http.entity.StringEntity stringEntity) Post an HTTP Request.
void	httpPostRequest(int port, long dpid, org.projectfloodlight.openflow.protocol.OFPacketOut ofPacketOut)
static java.io.BufferedReader	httpXmlPostRequest(org.apache.http.client.HttpClient httpClient, java.lang.String uri, org.apache.http.entity.StringEntity stringEntity)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRestApiHelper

public DefaultRestApiHelper()

Method Detail

createHttpClient

public static org.apache.http.client.HttpClient createHttpClient(java.lang.String username,
                                                                 java.lang.String password)

Create an HTTP client to connect to REST API server.

Parameters:

username - username

password - password

Returns:

an http client instance

getRequest

public static org.apache.http.client.methods.HttpGet getRequest(org.apache.http.client.HttpClient httpClient,
                                                                java.lang.String uri)

Get an http request.

Parameters:

httpClient - an instance of http client

uri - address of http page

Returns:

an instance of HttpGet

getResponse

public static org.apache.http.HttpResponse getResponse(org.apache.http.client.methods.HttpGet httpRequest,
                                                       org.apache.http.client.HttpClient httpClient)

Execute a http request to get a HTTP response.

Parameters:

httpRequest - an http request.

httpClient - an instance of http client.

Returns:

an HttpResponse instance

httpClientShutDown

public static void httpClientShutDown(org.apache.http.client.HttpClient httpClient)

Shut down http client connection.

Parameters:

httpClient - an instance of HTTP client.

httpPostRequest

public static java.io.BufferedReader httpPostRequest(org.apache.http.client.HttpClient httpClient,
                                                     java.lang.String uri,
                                                     org.apache.http.entity.StringEntity stringEntity)

Post an HTTP Request.

Parameters:

httpClient - an instance of HTTPClient

uri - URL address

stringEntity - an instance of the JSON entity which should be posted.

httpXmlPostRequest

public static java.io.BufferedReader httpXmlPostRequest(org.apache.http.client.HttpClient httpClient,
                                                        java.lang.String uri,
                                                        org.apache.http.entity.StringEntity stringEntity)

httpDelRequest

public static void httpDelRequest(org.apache.http.client.HttpClient httpClient,
                                  java.lang.String uri)

httpPostRequest

public void httpPostRequest(int port,
                            long dpid,
                            org.projectfloodlight.openflow.protocol.OFPacketOut ofPacketOut)
                     throws java.io.IOException

Throws:

java.io.IOException