HttpTool (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.util.http.HttpTool

public class HttpTool
extends java.lang.Object

A utility tool for HTTP operations.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpTool.HttpClientBuilder`
`static class`	`HttpTool.HttpDeleteBuilder`
`static class`	`HttpTool.HttpFormPostBuilder`
`static class`	`HttpTool.HttpGetBuilder`
`static class`	`HttpTool.HttpHeadBuilder`
`static class`	`HttpTool.HttpPostBuilder`
`static class`	`HttpTool.HttpPutBuilder`
`static class`	`HttpTool.TrustAllStrategy` Apache HTTP commons utility for trusting all.

Constructor Summary

Constructors
Constructor and Description

HttpTool()

Constructors
Constructor and Description
`HttpTool()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`closeQuietly(java.net.HttpURLConnection connection)` Closes all streams of the connection, and disconnects it.
`static java.net.URLConnection`	`connectToUrl(java.lang.String u)` Connects to the given url and returns the connection.
`static void`	`consumeAndCloseQuietly(java.net.HttpURLConnection connection)` Consumes the input stream entirely and then cleanly closes the connection.
`static java.lang.String`	`encodeUrlParams(java.util.Map<?,?> data)`
`static HttpToolResponse`	`execAndConsume(org.apache.http.client.HttpClient httpClient, org.apache.http.client.methods.HttpUriRequest req)`
`static java.lang.String`	`getContent(java.lang.String url)`
`static java.lang.String`	`getErrorContent(java.lang.String url)`
`static int`	`getHttpStatusCode(java.lang.String url)`
`static HttpTool.HttpClientBuilder`	`httpClientBuilder()`
`static HttpToolResponse`	`httpDelete(org.apache.http.client.HttpClient httpClient, java.net.URI uri, java.util.Map<java.lang.String,java.lang.String> headers)`
`static HttpToolResponse`	`httpGet(org.apache.http.client.HttpClient httpClient, java.net.URI uri, java.util.Map<java.lang.String,java.lang.String> headers)`
`static HttpToolResponse`	`httpHead(org.apache.http.client.HttpClient httpClient, java.net.URI uri, java.util.Map<java.lang.String,java.lang.String> headers)`
`static HttpToolResponse`	`httpPost(org.apache.http.client.HttpClient httpClient, java.net.URI uri, java.util.Map<java.lang.String,java.lang.String> headers, byte[] body)`
`static HttpToolResponse`	`httpPost(org.apache.http.client.HttpClient httpClient, java.net.URI uri, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> params)`
`static HttpToolResponse`	`httpPut(org.apache.http.client.HttpClient httpClient, java.net.URI uri, java.util.Map<java.lang.String,java.lang.String> headers, byte[] body)`
`static boolean`	`isStatusCodeHealthy(int code)`
`static java.lang.String`	`toBasicAuthorizationValue(org.apache.http.auth.UsernamePasswordCredentials credentials)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- HttpTool
```
public HttpTool()
```

Method Detail

connectToUrl
```
public static java.net.URLConnection connectToUrl(java.lang.String u)
                                           throws java.lang.Exception
```
Connects to the given url and returns the connection. Caller should connection.getInputStream().close() the result of this (especially if they are making heavy use of this method).

Throws:

java.lang.Exception

getHttpStatusCode

public static int getHttpStatusCode(java.lang.String url)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getContent

public static java.lang.String getContent(java.lang.String url)

getErrorContent

public static java.lang.String getErrorContent(java.lang.String url)

consumeAndCloseQuietly
```
public static void consumeAndCloseQuietly(java.net.HttpURLConnection connection)
```
Consumes the input stream entirely and then cleanly closes the connection. Ignores all exceptions completely, not even logging them! Consuming the stream fully is useful for preventing idle TCP connections.

See Also:
Persistent Connections

closeQuietly
```
public static void closeQuietly(java.net.HttpURLConnection connection)
```
Closes all streams of the connection, and disconnects it. Ignores all exceptions completely, not even logging them!

httpClientBuilder

public static HttpTool.HttpClientBuilder httpClientBuilder()

httpGet

public static HttpToolResponse httpGet(org.apache.http.client.HttpClient httpClient,
                       java.net.URI uri,
                       java.util.Map<java.lang.String,java.lang.String> headers)

httpPost

public static HttpToolResponse httpPost(org.apache.http.client.HttpClient httpClient,
                        java.net.URI uri,
                        java.util.Map<java.lang.String,java.lang.String> headers,
                        byte[] body)

httpPut

public static HttpToolResponse httpPut(org.apache.http.client.HttpClient httpClient,
                       java.net.URI uri,
                       java.util.Map<java.lang.String,java.lang.String> headers,
                       byte[] body)

httpPost

public static HttpToolResponse httpPost(org.apache.http.client.HttpClient httpClient,
                        java.net.URI uri,
                        java.util.Map<java.lang.String,java.lang.String> headers,
                        java.util.Map<java.lang.String,java.lang.String> params)

httpDelete

public static HttpToolResponse httpDelete(org.apache.http.client.HttpClient httpClient,
                          java.net.URI uri,
                          java.util.Map<java.lang.String,java.lang.String> headers)

httpHead

public static HttpToolResponse httpHead(org.apache.http.client.HttpClient httpClient,
                        java.net.URI uri,
                        java.util.Map<java.lang.String,java.lang.String> headers)

execAndConsume

public static HttpToolResponse execAndConsume(org.apache.http.client.HttpClient httpClient,
                              org.apache.http.client.methods.HttpUriRequest req)

isStatusCodeHealthy

public static boolean isStatusCodeHealthy(int code)

toBasicAuthorizationValue

public static java.lang.String toBasicAuthorizationValue(org.apache.http.auth.UsernamePasswordCredentials credentials)

encodeUrlParams

public static java.lang.String encodeUrlParams(java.util.Map<?,?> data)

Class HttpTool

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpTool

Method Detail

connectToUrl

getHttpStatusCode

getContent

getErrorContent

consumeAndCloseQuietly

closeQuietly

httpClientBuilder

httpGet

httpPost

httpPut

httpPost

httpDelete

httpHead

execAndConsume

isStatusCodeHealthy

toBasicAuthorizationValue

encodeUrlParams