Package com.broadleafcommerce.asset.jackson

Interface ContentUrlResolver

All Known Implementing Classes:
ServletContentUrlResolver
public interface ContentUrlResolver
Responsible for being able to take an Asset and building a fully resolved content URL path that can be used to directly fetch the binary data of the asset.

The default implementation works for web applications of type ConditionalOnWebApplication.Type.SERVLET. A web application with a different type should have a different implementation.

Author:
Samarth Dhruva (samarthd)
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getContentUrl(Asset asset)
    Builds and returns a fully resolved content URL path that can be used to directly fetch the binary data of the asset.

  • Method Details

    • getContentUrl

      @Nullable String getContentUrl(@NonNull Asset asset)
      Builds and returns a fully resolved content URL path that can be used to directly fetch the binary data of the asset.
      Parameters:
      asset - the asset for which to create the content URL
      Returns:
      a fully resolved content URL path that can be used to directly fetch the binary data of the asset. Can be null if Asset.getUrl() is null.
      Throws:
      IllegalArgumentException - if an internal asset is found to have a blank url