Class Headers

java.lang.Object
kong.unirest.core.Headers
public class Headers extends Object
Represents a collection of headers

  • Constructor Details

    • Headers

      public Headers()

    • Headers

      public Headers(Collection<kong.unirest.core.Headers.Entry> entries)

  • Method Details

    • add

      public void add(String name, String value)
      Add a header element
      Parameters:
      name - the name of the header
      value - the value for the header

    • add

      public void add(String name, Supplier<String> value)
      Add a header element with a supplier which will be evaluated on request
      Parameters:
      name - the name of the header
      value - the value for the header

    • replace

      public void replace(String name, String value)
      Replace a header value. If there are multiple instances it will overwrite all of them
      Parameters:
      name - the name of the header
      value - the value for the header

    • remove

      public void remove(String name)
      Remove a header by name
      Parameters:
      name - the name of the header

    • size

      public int size()
      Get the number of header keys.
      Returns:
      the size of the header keys

    • get

      public List<String> get(String name)
      Get all the values for a header name
      Parameters:
      name - name of the header element
      Returns:
      a list of values

    • putAll

      public void putAll(Headers header)
      Add a bunch of headers at once
      Parameters:
      header - a header

    • containsKey

      public boolean containsKey(String name)
      Check if a header is present
      Parameters:
      name - a header
      Returns:
      if the headers contain this name.

    • clear

      public void clear()
      Clear the headers!

    • getFirst

      public String getFirst(String key)
      Get the first header value for a name
      Parameters:
      key - the name of the header
      Returns:
      the first value

    • all

      public List<Header> all()
      Get all of the headers
      Returns:
      all the headers, in order

    • cookie

      public void cookie(Cookie cookie)
      Add a Cookie header
      Parameters:
      cookie - the cookie

    • cookie

      public void cookie(Collection<Cookie> cookies)
      sets a collection of cookies
      Parameters:
      cookies - some cookies

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      list all headers like this: 
      Content-Length: 42
Cache-Control: no-cache
...

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • setBasicAuth

      public void setBasicAuth(String username, String password)
      creates a basic auth header from a username and password. The creds will be the Base64 encoded value of {username}:{password} along with the 'Basic' schema For example given a creds of "username" and "password" you would get eg: Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
      Parameters:
      username - the username
      password - the password

    • accepts

      public void accepts(String value)
      sets the Accept header
      Parameters:
      value - the value for accept

    • add

      public void add(Map<String,String> headerMap)
      Sets headers based on a map of key-value pairs
      Parameters:
      headerMap - I'm the MAP

    • replace

      public void replace(Map<String,String> headerMap)
      Replace all headers from a given map.
      Parameters:
      headerMap - the map of headers