Module io.helidon.webclient.api
Package io.helidon.webclient.api

Class WebClientCookieManagerConfig.BuilderBase<BUILDER extends WebClientCookieManagerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientCookieManagerConfig>

java.lang.Object
io.helidon.webclient.api.WebClientCookieManagerConfig.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>, Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
WebClientCookieManagerConfig.Builder
Enclosing interface:
WebClientCookieManagerConfig
public abstract static class WebClientCookieManagerConfig.BuilderBase<BUILDER extends WebClientCookieManagerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientCookieManagerConfig> extends Object implements Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for WebClientCookieManager.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(WebClientCookieManagerConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(WebClientCookieManagerConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface Prototype.ConfiguredBuilder<BUILDER extends WebClientCookieManagerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientCookieManagerConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • automaticStoreEnabled

      public BUILDER automaticStoreEnabled(boolean automaticStoreEnabled)
      Whether automatic cookie store is enabled or not.
      Parameters:
      automaticStoreEnabled - status of cookie store
      Returns:
      updated builder instance
      See Also:

    • cookiePolicy

      public BUILDER cookiePolicy(CookiePolicy cookiePolicy)
      Current cookie policy for this client.
      Parameters:
      cookiePolicy - the cookie policy
      Returns:
      updated builder instance
      See Also:

    • defaultCookies

      public BUILDER defaultCookies(Map<? extends String,? extends String> defaultCookies)
      This method replaces all values with the new ones.
      Parameters:
      defaultCookies - map of default cookies
      Returns:
      updated builder instance
      See Also:

    • addDefaultCookies

      public BUILDER addDefaultCookies(Map<? extends String,? extends String> defaultCookies)
      This method keeps existing values, then puts all new values into the map.
      Parameters:
      defaultCookies - map of default cookies
      Returns:
      updated builder instance
      See Also:

    • putDefaultCookie

      public BUILDER putDefaultCookie(String key, String defaultCookie)
      This method adds a new value to the map, or replaces it if the key already exists.
      Parameters:
      key - key to add or replace
      defaultCookie - new value for the key
      Returns:
      updated builder instance
      See Also:

    • clearCookieStore

      public BUILDER clearCookieStore()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • cookieStore

      public BUILDER cookieStore(CookieStore cookieStore)
      The cookie store where cookies are kept. If not defined, JDK default is used (in memory store).
      Parameters:
      cookieStore - cookie store
      Returns:
      updated builder instance
      See Also:

    • automaticStoreEnabled

      public boolean automaticStoreEnabled()
      Whether automatic cookie store is enabled or not.
      Returns:
      the automatic store enabled

    • cookiePolicy

      public CookiePolicy cookiePolicy()
      Current cookie policy for this client.
      Returns:
      the cookie policy

    • defaultCookies

      public Map<String,String> defaultCookies()
      Map of default cookies to include in all requests if cookies enabled.
      Returns:
      the default cookies

    • cookieStore

      public Optional<CookieStore> cookieStore()
      The cookie store where cookies are kept. If not defined, JDK default is used (in memory store).
      Returns:
      the cookie store

    • config

      public Optional<Config> config()
      If this instance was configured, this would be the config instance used.
      Returns:
      config node used to configure this builder, or empty if not configured

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.