EntityHttpClient (Apache Brooklyn)

All Known Implementing Classes:

EntityHttpClientImpl
```
public interface EntityHttpClient
```
Helpful methods for making HTTP requests to BrooklynNode entities.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class EntityHttpClient.ResponseCodePredicates

Nested Classes
Modifier and Type	Interface and Description
`static class`	`EntityHttpClient.ResponseCodePredicates`

Method Summary

Methods
Modifier and Type	Method and Description
`HttpToolResponse`	`delete(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> headers)` Makes an HTTP DELETE to a Brooklyn node entity.
`HttpToolResponse`	`get(java.lang.String path)` Makes an HTTP GET to a Brooklyn node entity.
`HttpTool.HttpClientBuilder`	`getHttpClientForBrooklynNode()`
`HttpToolResponse`	`post(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> headers, byte[] body)` Makes an HTTP POST to a Brooklyn node entity.
`HttpToolResponse`	`post(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> formParams)` Makes an HTTP POST to a Brooklyn node entity.
`EntityHttpClient`	`responseSuccess(com.google.common.base.Predicate<java.lang.Integer> responseSuccess)` Configure which response codes are treated as successful

- Method Detail
  - getHttpClientForBrooklynNode
```
HttpTool.HttpClientBuilder getHttpClientForBrooklynNode()
```
    Returns:
    An HTTP client builder configured to access the web console URI at the given entity, or null if the entity has no URI.
  - responseSuccess
```
EntityHttpClient responseSuccess(com.google.common.base.Predicate<java.lang.Integer> responseSuccess)
```
    Configure which response codes are treated as successful
    
    Parameters:
    successPredicate - A predicate which returns true is the response code is acceptable
    
    Returns:
    this
  - get
```
HttpToolResponse get(java.lang.String path)
```
    Makes an HTTP GET to a Brooklyn node entity.
    
    Parameters:
    path - Relative path to resource on server, e.g v1/catalog
    
    Returns:
    The server's response
  - post
```
HttpToolResponse post(java.lang.String path,
                    java.util.Map<java.lang.String,java.lang.String> headers,
                    byte[] body)
```
    Makes an HTTP POST to a Brooklyn node entity.
    
    Parameters:
    path - Relative path to resource on server, e.g v1/catalog
    body - byte array of serialized JSON to attach to the request
    
    Returns:
    The server's response
  - post
```
HttpToolResponse post(java.lang.String path,
                    java.util.Map<java.lang.String,java.lang.String> headers,
                    java.util.Map<java.lang.String,java.lang.String> formParams)
```
    Makes an HTTP POST to a Brooklyn node entity.
    
    Parameters:
    path - Relative path to resource on server, e.g v1/catalog
    formParams - The parameters to send in a x-www-form-urlencoded format
    
    Returns:
    The server's response
  - delete
```
HttpToolResponse delete(java.lang.String path,
                      java.util.Map<java.lang.String,java.lang.String> headers)
```
    Makes an HTTP DELETE to a Brooklyn node entity.
    
    Parameters:
    path - Relative path to resource on server, e.g v1/catalog
    
    Returns:
    The server's response

Interface EntityHttpClient

Nested Class Summary

Method Summary

Method Detail

getHttpClientForBrooklynNode

responseSuccess

get

post

post

delete