Package com.commercetools.api.models.extension

Interface HttpDestination

All Superinterfaces:
ExtensionDestination
All Known Subinterfaces:
ExtensionHttpDestination
All Known Implementing Classes:
HttpDestinationImpl
public interface HttpDestination extends ExtensionDestination

We recommend an encrypted HTTPS connection for production setups. However, we also accept unencrypted HTTP connections for development purposes. HTTP redirects will not be followed and cache headers will be ignored.

Example to create an instance using the builder pattern 

     HttpDestination httpDestination = HttpDestination.builder()
             .url("{url}")
             .build()

  • Field Details

  • Method Details

    • getUrl

      @NotNull @NotNull String getUrl()

      URL to the target destination. If the Project is hosted in the China (AWS, Ningxia) Region, verify that the URL is not blocked due to firewall restrictions.

      Returns:
      url

    • getAuthentication

      @Valid @Valid HttpDestinationAuthentication getAuthentication()

      Authentication methods (such as Basic or Bearer).

      Returns:
      authentication

    • setUrl

      void setUrl(String url)

      URL to the target destination. If the Project is hosted in the China (AWS, Ningxia) Region, verify that the URL is not blocked due to firewall restrictions.

      Parameters:
      url - value to be set

    • setAuthentication

      void setAuthentication(HttpDestinationAuthentication authentication)

      Authentication methods (such as Basic or Bearer).

      Parameters:
      authentication - value to be set

    • of

      static HttpDestination of()
      factory method
      Returns:
      instance of HttpDestination

    • of

      static HttpDestination of(HttpDestination template)
      factory method to create a shallow copy HttpDestination
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static HttpDestination deepCopy(@Nullable HttpDestination template)
      factory method to create a deep copy of HttpDestination
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static HttpDestinationBuilder builder()
      builder factory method for HttpDestination
      Returns:
      builder

    • builder

      static HttpDestinationBuilder builder(HttpDestination template)
      create builder for HttpDestination instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withHttpDestination

      default <T> T withHttpDestination(Function<HttpDestination,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<HttpDestination> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference