Webb (DavidWebb 1.3.0-SNAPSHOT API)

java.lang.Object
- com.goebl.david.Webb

```
public class Webb
extends Object
```
Lightweight Java HTTP-Client for calling JSON REST-Services (especially for Android).

Author:

hgoebl

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APP_BINARY`
`static String`	`APP_FORM`
`static String`	`APP_JSON`
`static String`	`DEFAULT_USER_AGENT`
`static String`	`HDR_ACCEPT`
`static String`	`HDR_ACCEPT_ENCODING`
`static String`	`HDR_AUTHORIZATION`
`static String`	`HDR_CONTENT_ENCODING`
`static String`	`HDR_CONTENT_TYPE`
`static String`	`HDR_USER_AGENT`
`static String`	`TEXT_PLAIN`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Webb()

Constructors
Modifier	Constructor and Description
`protected`	`Webb()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Webb`	`create()` Create an instance which can be reused for multiple requests in the same Thread.
`Request`	`delete(String pathOrUri)` Creates a DELETE HTTP request with the specified absolute or relative URI.
`Request`	`get(String pathOrUri)` Creates a GET HTTP request with the specified absolute or relative URI.
`String`	`getBaseUri()` Returns the base URI of this instance.
`Request`	`post(String pathOrUri)` Creates a POST HTTP request with the specified absolute or relative URI.
`Request`	`put(String pathOrUri)` Creates a PUT HTTP request with the specified absolute or relative URI.
`void`	`setBaseUri(String baseUri)` Set the base URI for all requests created from this instance.
`static void`	`setConnectTimeout(int globalConnectTimeout)` Set the timeout in milliseconds for connecting the server.
`void`	`setDefaultHeader(String name, Object value)` Set the value for a named header which is valid for all requests created by this instance.
`void`	`setFollowRedirects(boolean auto)` See .
`static void`	`setGlobalBaseUri(String globalBaseUri)` Set the base URI for all requests starting in this JVM from now.
`static void`	`setGlobalHeader(String name, Object value)` Set the value for a named header which is valid for all requests in the running JVM.
`void`	`setHostnameVerifier(HostnameVerifier hostnameVerifier)` Set a custom `HostnameVerifier`, most likely to relax host-name checking.
`static void`	`setJsonIndentFactor(int indentFactor)` The number of characters to indent child properties, `-1` for "productive" code.
`static void`	`setReadTimeout(int globalReadTimeout)` Set the timeout in milliseconds for getting response from the server.
`void`	`setRetryManager(RetryManager retryManager)` Registers an alternative `RetryManager`.
`void`	`setSSLSocketFactory(SSLSocketFactory sslSocketFactory)` Set a custom `SSLSocketFactory`, most likely to relax Certification checking.

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

- Field Detail
  - DEFAULT_USER_AGENT
```
public static final String DEFAULT_USER_AGENT
```
    See Also:
    
    Constant Field Values
  - APP_FORM
```
public static final String APP_FORM
```
    See Also:
    
    Constant Field Values
  - APP_JSON
```
public static final String APP_JSON
```
    See Also:
    
    Constant Field Values
  - APP_BINARY
```
public static final String APP_BINARY
```
    See Also:
    
    Constant Field Values
  - TEXT_PLAIN
```
public static final String TEXT_PLAIN
```
    See Also:
    
    Constant Field Values
  - HDR_CONTENT_TYPE
```
public static final String HDR_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - HDR_CONTENT_ENCODING
```
public static final String HDR_CONTENT_ENCODING
```
    See Also:
    
    Constant Field Values
  - HDR_ACCEPT
```
public static final String HDR_ACCEPT
```
    See Also:
    
    Constant Field Values
  - HDR_ACCEPT_ENCODING
```
public static final String HDR_ACCEPT_ENCODING
```
    See Also:
    
    Constant Field Values
  - HDR_USER_AGENT
```
public static final String HDR_USER_AGENT
```
    See Also:
    
    Constant Field Values
  - HDR_AUTHORIZATION
```
public static final String HDR_AUTHORIZATION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Webb
```
protected Webb()
```
- Method Detail
  - create
```
public static Webb create()
```
    Create an instance which can be reused for multiple requests in the same Thread.
    
    Returns:
    
    the created instance.
  - setGlobalHeader
```
public static void setGlobalHeader(String name,
                                   Object value)
```
    Set the value for a named header which is valid for all requests in the running JVM.
    The value can be overwritten by calling setDefaultHeader(String, Object) and/or Request.header(String, Object).
    For the supported types for values see Request.header(String, Object).
    
    Parameters:
    
    name - name of the header (regarding HTTP it is not case-sensitive, but here case is important).
    
    value - value of the header. If null the header value is cleared (effectively not set).
    
    See Also:
    
    setDefaultHeader(String, Object), Request.header(String, Object)
  - setGlobalBaseUri
```
public static void setGlobalBaseUri(String globalBaseUri)
```
    Set the base URI for all requests starting in this JVM from now.
    For all requests this value is taken as a kind of prefix for the effective URI, so you can address the URIs relatively. The value is only taken when setBaseUri(String) is not called or called with null.
    
    Parameters:
    
    globalBaseUri - the prefix for all URIs of new Requests.
    
    See Also:
    
    setBaseUri(String)
  - setJsonIndentFactor
```
public static void setJsonIndentFactor(int indentFactor)
```
    The number of characters to indent child properties, -1 for "productive" code.
    Default is production ready JSON (-1) means no indentation (single-line serialization).
    
    Parameters:
    
    indentFactor - the number of spaces to indent
  - setConnectTimeout
```
public static void setConnectTimeout(int globalConnectTimeout)
```
    Set the timeout in milliseconds for connecting the server.
    In contrast to HttpURLConnection, we use a default timeout of 10 seconds, since no timeout is odd.
    Can be overwritten for each Request with Request.connectTimeout(int).
    
    Parameters:
    
    globalConnectTimeout - the new timeout or <= 0 to use HttpURLConnection default timeout.
  - setReadTimeout
```
public static void setReadTimeout(int globalReadTimeout)
```
    Set the timeout in milliseconds for getting response from the server.
    In contrast to HttpURLConnection, we use a default timeout of 3 minutes, since no timeout is odd.
    Can be overwritten for each Request with Request.readTimeout(int).
    
    Parameters:
    
    globalReadTimeout - the new timeout or <= 0 to use HttpURLConnection default timeout.
  - setFollowRedirects
```
public void setFollowRedirects(boolean auto)
```
    See .
    Use this method to set the behaviour for all requests created by this instance when receiving redirect responses. You can overwrite the setting for a single request by calling Request.followRedirects(boolean).
    
    Parameters:
    
    auto - true to automatically follow redirects (HTTP status code 3xx). Default value comes from HttpURLConnection and should be true.
  - setSSLSocketFactory
```
public void setSSLSocketFactory(SSLSocketFactory sslSocketFactory)
```
    Set a custom SSLSocketFactory, most likely to relax Certification checking.
    
    Parameters:
    
    sslSocketFactory - the factory to use (see test cases for an example).
  - setHostnameVerifier
```
public void setHostnameVerifier(HostnameVerifier hostnameVerifier)
```
    Set a custom HostnameVerifier, most likely to relax host-name checking.
    
    Parameters:
    
    hostnameVerifier - the verifier (see test cases for an example).
  - setBaseUri
```
public void setBaseUri(String baseUri)
```
    Set the base URI for all requests created from this instance.
    For all requests this value is taken as a kind of prefix for the effective URI, so you can address the URIs relatively. The value takes precedence over the value set in setGlobalBaseUri(String).
    
    Parameters:
    
    baseUri - the prefix for all URIs of new Requests.
    
    See Also:
    
    setGlobalBaseUri(String)
  - getBaseUri
```
public String getBaseUri()
```
    Returns the base URI of this instance.
    
    Returns:
    
    base URI
  - setDefaultHeader
```
public void setDefaultHeader(String name,
                             Object value)
```
    Set the value for a named header which is valid for all requests created by this instance.
    The value takes precedence over setGlobalHeader(String, Object) but can be overwritten by Request.header(String, Object).
    For the supported types for values see Request.header(String, Object).
    
    Parameters:
    
    name - name of the header (regarding HTTP it is not case-sensitive, but here case is important).
    
    value - value of the header. If null the header value is cleared (effectively not set). When setting the value to null, a value from global headers can shine through.
    
    See Also:
    
    setGlobalHeader(String, Object), Request.header(String, Object)
  - setRetryManager
```
public void setRetryManager(RetryManager retryManager)
```
    Registers an alternative RetryManager.
    
    Parameters:
    
    retryManager - the new manager for deciding whether it makes sense to retry a request.
  - get
```
public Request get(String pathOrUri)
```
    Creates a GET HTTP request with the specified absolute or relative URI.
    
    Parameters:
    
    pathOrUri - the URI (will be concatenated with global URI or default URI without further checking). If it starts already with http:// or https:// this URI is taken and all base URIs are ignored.
    
    Returns:
    
    the created Request object (in fact it's more a builder than a real request object)
  - post
```
public Request post(String pathOrUri)
```
    Creates a POST HTTP request with the specified absolute or relative URI.
    
    Parameters:
    
    pathOrUri - the URI (will be concatenated with global URI or default URI without further checking) If it starts already with http:// or https:// this URI is taken and all base URIs are ignored.
    
    Returns:
    
    the created Request object (in fact it's more a builder than a real request object)
  - put
```
public Request put(String pathOrUri)
```
    Creates a PUT HTTP request with the specified absolute or relative URI.
    
    Parameters:
    
    pathOrUri - the URI (will be concatenated with global URI or default URI without further checking) If it starts already with http:// or https:// this URI is taken and all base URIs are ignored.
    
    Returns:
    
    the created Request object (in fact it's more a builder than a real request object)
  - delete
```
public Request delete(String pathOrUri)
```
    Creates a DELETE HTTP request with the specified absolute or relative URI.
    
    Parameters:
    
    pathOrUri - the URI (will be concatenated with global URI or default URI without further checking) If it starts already with http:// or https:// this URI is taken and all base URIs are ignored.
    
    Returns:
    
    the created Request object (in fact it's more a builder than a real request object)

Class Webb

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_USER_AGENT

APP_FORM

APP_JSON

APP_BINARY

TEXT_PLAIN

HDR_CONTENT_TYPE

HDR_CONTENT_ENCODING

HDR_ACCEPT

HDR_ACCEPT_ENCODING

HDR_USER_AGENT

HDR_AUTHORIZATION

Constructor Detail

Webb

Method Detail

create

setGlobalHeader

setGlobalBaseUri

setJsonIndentFactor

setConnectTimeout

setReadTimeout

setFollowRedirects

setSSLSocketFactory

setHostnameVerifier

setBaseUri

getBaseUri

setDefaultHeader

setRetryManager

get

post

put

delete