Package ca.uhn.fhir.rest.gclient

Interface IClientHttpExecutable<T extends IClientHttpExecutable<?,Y>,Y>

Type Parameters:
T - the builder self type
Y - the result type
public interface IClientHttpExecutable<T extends IClientHttpExecutable<?,Y>,Y>
The non-FHIR bits of IClientExecutable.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    accept(String theHeaderValue)
    Specifies a custom Accept header that should be supplied with the request.
    T
    cacheControl(CacheControlDirective theCacheControlDirective)
    Sets the Cache-Control header value, which advises the server (or any cache in front of it) how to behave in terms of cached requests
    Y
    execute()
    Actually execute the client operation and return the result.
    T
    withAdditionalHeader(String theHeaderName, String theHeaderValue)
    Set an HTTP header.

  • Method Details

    • cacheControl

      T cacheControl(CacheControlDirective theCacheControlDirective)
      Sets the Cache-Control header value, which advises the server (or any cache in front of it) how to behave in terms of cached requests

    • withAdditionalHeader

      T withAdditionalHeader(String theHeaderName, String theHeaderValue)
      Set an HTTP header. One

      It is the responsibility of the caller to care for proper encoding of the header value, e.g. using Base64.

      This is a short-cut alternative to using a corresponding client interceptor

      It is a multi-valued header. Calling it multiple times will add to the list rather than replace the value

      Parameters:
      theHeaderName - header name
      theHeaderValue - header value
      Returns:

    • execute

      Y execute()
      Actually execute the client operation and return the result.
      Returns:
      The result of the HTTP operation

    • accept

      T accept(String theHeaderValue)
      Specifies a custom Accept header that should be supplied with the request.
      Parameters:
      theHeaderValue - The header value, e.g. "application/json". If set to null or an empty string, the default Accept header will be used.