Package com.netflix.spinnaker.kork.plugins.api.httpclient

Interface HttpClient

@Beta
public interface HttpClient

A simple HTTP client abstraction for use by plugins to talk to other Spinnaker services.

Many plugins will need to communicate with other Spinnaker services. Supplying plugins with a Retrofit client or similar, and including all of its dependencies as a global plugin contract, would be cause for a potential dependency management nightmare. HttpClient is used as an abstraction layer over what HTTP libraries we use internally to talk between services, allowing us to change the internals over time easier without affecting the plugin community.

Since this is an abstraction, plugins will not need to configure their own HTTP clients with keystores/truststores, etc, as operators will be defining this once for the Spinnaker service that the plugin is for.

It is not mandatory for plugins to use this HttpClient for all HTTP/RPC needs. If a plugin wants to use Spring's WebClient, Retrofit, or something else, they are still able to do so.

 // Internal services can be retrieved by name.
 HttpClient front50Client = httpClientProvider.getInternalService("front50");

 Response response = front50Client.get(new Request("getApplication", "/v2/applications/gate"));

 Application app = response.getBody(Application.class);
 

TODO(rz): Add async api as well?

Method Summary

Modifier and Type	Method	Description
Response	delete(Request request)
Response	get(Request request)
Response	patch(Request request)
Response	post(Request request)
Response	put(Request request)

Method Detail

get

@Nonnull
Response get(@Nonnull
             Request request)

post

@Nonnull
Response post(@Nonnull
              Request request)

put

@Nonnull
Response put(@Nonnull
             Request request)

delete

@Nonnull
Response delete(@Nonnull
                Request request)

patch

@Nonnull
Response patch(@Nonnull
               Request request)