Package com.broadleafcommerce.common.extension.intercommunication

Class ExternalRequest

java.lang.Object
com.broadleafcommerce.common.extension.intercommunication.ExternalRequest
@Deprecated(forRemoval=true) public class ExternalRequest extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
use the facilities in com.broadleafcommerce.data.tracking.core.interlink.DefaultInterlinkClient instead.
Store details regarding an interlink call to another microservice. Generally, this information is consumed by an instance of ExternalClient.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExternalRequest()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    equals(Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Consumer<Map<String,Object>>
    getAttributes()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    <E extends Throwable, T>
    Function<E,reactor.core.publisher.Mono<T>>
    getFallback()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Consumer<org.springframework.http.HttpHeaders>
    getHeaders()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Locale
    getLocale()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<Object>
    getPayloads()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getPrincipal()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getUri()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setAttributes(Consumer<Map<String,Object>> attributes)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setFallback(Function<?,?> fallback)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setHeaders(Consumer<org.springframework.http.HttpHeaders> headers)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setLocale(Locale locale)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setPayloads(List<Object> payloads)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setPrincipal(String principal)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setUri(String uri)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    ExternalRequest
    withAttributes(Consumer<Map<String,Object>> attributes)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Consumer for request attributes to apply during the request.
    <E extends Throwable, T>
    ExternalRequest
    withFallback(Function<E,reactor.core.publisher.Mono<T>> fallback)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Provides a function to provide a fallback response in case of error during WebClient call.
    ExternalRequest
    withHeaders(Consumer<org.springframework.http.HttpHeaders> headers)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Consumer for headers to apply during the request.
    ExternalRequest
    withLocale(Locale locale)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The locale that should be associated with the call.
    ExternalRequest
    withPayloads(List<Object> payloads)
    Deprecated, for removal: This API element is subject to removal in a future version.
    One or more payload objects that may either be used as direct method call params, or serialized as JSON in request body posts.
    ExternalRequest
    withPrincipal(String principal)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The authentication principal name that should be associated with the call.
    ExternalRequest
    withUri(String uri)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The uri used for WebClient connection.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ExternalRequest

      public ExternalRequest()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • withUri

      public ExternalRequest withUri(String uri)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The uri used for WebClient connection. This information is also used internally in ExternalClient for determination of ContextInfo, among others.
      Parameters:
      uri - The uri used for WebClient connection
      Returns:
      This

    • withAttributes

      public ExternalRequest withAttributes(Consumer<Map<String,Object>> attributes)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Consumer for request attributes to apply during the request. Generally used during WebClient network requests, but may be also interpreted for other purposes in the ExternalClient.
      Parameters:
      attributes - Consumer for request attributes to apply during the request
      Returns:
      This

    • withHeaders

      public ExternalRequest withHeaders(Consumer<org.springframework.http.HttpHeaders> headers)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Consumer for headers to apply during the request. Generally used during WebClient network requests, but may be also interpreted for other purposes in the ExternalClient.
      Parameters:
      headers - Consumer for headers to apply during the request.
      Returns:
      This

    • withPayloads

      public ExternalRequest withPayloads(List<Object> payloads)
      Deprecated, for removal: This API element is subject to removal in a future version.
      One or more payload objects that may either be used as direct method call params, or serialized as JSON in request body posts.
      Parameters:
      payloads - The main object params to pass for the call
      Returns:
      This

    • withPrincipal

      public ExternalRequest withPrincipal(String principal)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The authentication principal name that should be associated with the call. This is generally used for construction of ContextInfo instances during direct method calls in the ExternalClient.
      Parameters:
      principal - The principal name to use
      Returns:
      This

    • withLocale

      public ExternalRequest withLocale(Locale locale)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The locale that should be associated with the call. This is generally used for construction of ContextInfo instances during direct method calls in the ExternalClient.
      Parameters:
      locale - The locale to use
      Returns:
      This

    • withFallback

      public <E extends Throwable, T> ExternalRequest withFallback(Function<E,reactor.core.publisher.Mono<T>> fallback)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Provides a function to provide a fallback response in case of error during WebClient call. This is passed to Mono#onErrorResume(Class, Function) during WebClient connection construction.
      Type Parameters:
      E - The exception encountered during WebClient processing
      T - The type of the fallback response
      Parameters:
      fallback - The function providing a fallback response
      Returns:
      This

    • getFallback

      public <E extends Throwable, T> Function<E,reactor.core.publisher.Mono<T>> getFallback()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getUri

      public String getUri()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getAttributes

      public Consumer<Map<String,Object>> getAttributes()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getHeaders

      public Consumer<org.springframework.http.HttpHeaders> getHeaders()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getPayloads

      public List<Object> getPayloads()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getPrincipal

      public String getPrincipal()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getLocale

      public Locale getLocale()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setUri

      public void setUri(String uri)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setAttributes

      public void setAttributes(Consumer<Map<String,Object>> attributes)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setHeaders

      public void setHeaders(Consumer<org.springframework.http.HttpHeaders> headers)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setPayloads

      public void setPayloads(List<Object> payloads)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setPrincipal

      public void setPrincipal(String principal)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setLocale

      public void setLocale(Locale locale)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setFallback

      public void setFallback(Function<?,?> fallback)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • equals

      public boolean equals(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object