Package com.janeirodigital.shapetrees.core.contentloaders

Interface ExternalDocumentLoader

All Known Implementing Classes:
HttpExternalDocumentLoader, OkHttpExternalDocumentLoader
public interface ExternalDocumentLoader
Interface defining how a remote document can be loaded and its contents extracted. Implementations can add capabilities like caching, retrieving resources from alternate locations, etc.

  • Method Summary

    Modifier and Type
    Method
    Description
    DocumentResponse
    loadExternalDocument(URL resourceUrl)
    Describes the retrieval of a remote document

  • Method Details

    • loadExternalDocument

      DocumentResponse loadExternalDocument(URL resourceUrl) throws ShapeTreeException
      Describes the retrieval of a remote document
      Parameters:
      resourceUrl - URL of resource to be retrieved
      Returns:
      DocumentResponse representation which contains body and content type
      Throws:
      ShapeTreeException - ShapeTreeException