Module io.inverno.mod.web.client
Package io.inverno.mod.web.client

Interface WebClient.WebExchangeBuilder<A extends ExchangeContext>

Type Parameters:
A - the exchange context type
All Superinterfaces:
Cloneable
Enclosing interface:
WebClient<A extends ExchangeContext>
public static interface WebClient.WebExchangeBuilder<A extends ExchangeContext> extends Cloneable

A Web exchange builder.

  • Method Details

    • method

      WebClient.WebExchangeBuilder<A> method(Method method)

      Specifies the request method.

      Parameters:
      method - the HTTP method
      Returns:
      the Web exchange builder

    • path

      WebClient.WebExchangeBuilder<A> path(String path)

      Specifies the request target.

      Parameters:
      path - the request target
      Returns:
      the Web exchange builder

    • pathParameter

      <T> WebClient.WebExchangeBuilder<A> pathParameter(String name, T value)

      Specifies the value of a path parameter in the request path.

      The specified value is converted to a String using the module's parameter converter.

      Type Parameters:
      T - the parameter value type
      Parameters:
      name - the parameter name
      value - the parameter value
      Returns:
      the Web exchange builder

    • pathParameter

      default <T> WebClient.WebExchangeBuilder<A> pathParameter(String name, T value, Class<T> type)

      Specifies the value of a path parameter in the request path.

      The specified value is converted to a String using the module's parameter converter.

      Type Parameters:
      T - the parameter value type
      Parameters:
      name - the parameter name
      value - the parameter value
      type - the parameter value type
      Returns:
      the Web exchange builder

    • pathParameter

      <T> WebClient.WebExchangeBuilder<A> pathParameter(String name, T value, Type type)

      Specifies the value of a path parameter in the request path.

      The specified value is converted to a String using the module's parameter converter.

      Type Parameters:
      T - the parameter value type
      Parameters:
      name - the parameter name
      value - the parameter value
      type - the parameter value type
      Returns:
      the Web exchange builder

    • queryParameter

      <T> WebClient.WebExchangeBuilder<A> queryParameter(String name, T value)

      Adds a query parameter.

      The specified value is converted to a String using the module's parameter converter.

      Type Parameters:
      T - the parameter value type
      Parameters:
      name - the parameter name
      value - the parameter value type
      Returns:
      the Web exchange builder

    • queryParameter

      default <T> WebClient.WebExchangeBuilder<A> queryParameter(String name, T value, Class<T> type)

      Adds a query parameter.

      The specified value is converted to a String using the module's parameter converter.

      Type Parameters:
      T - the parameter value type
      Parameters:
      name - the parameter name
      value - the parameter value
      type - the parameter value type
      Returns:
      the Web exchange builder

    • queryParameter

      <T> WebClient.WebExchangeBuilder<A> queryParameter(String name, T value, Type type)

      Adds a query parameter.

      The specified value is converted to a String using the module's parameter converter.

      Type Parameters:
      T - the parameter value type
      Parameters:
      name - the parameter name
      value - the parameter value
      type - the parameter value type
      Returns:
      the Web exchange builder

    • build

      Mono<WebExchange<A>> build()

      Builds the Web exchange.

      Returns:
      a Mono emitting the Web exchange

    • clone

      WebClient.WebExchangeBuilder<A> clone()

      Clones the Web exchange builder.

      Returns:
      a clone of the Web exchange builder