ResourceFactory (api API)

public interface ResourceFactory

Method Summary

Modifier and Type

Method

Description

void

add(ResourceLoader loader)

CreateHandle

create(CreateRequest toCreate)

Make a request to store a resource according to the given request.

default CreateHandle

create(CreateRequest toCreate, String name, String contentType)

Convenience version of create that calls create(CreateRequest) with a new request, derived from the given request and the given name and content type.

List<ResourceLoader>

getLoaders()

Resource

load(String target, URI relativeTo)

Resource

load(URI target)

Resource

load(URI target, URI relativeTo)

Method Details
- add
  
  void add(ResourceLoader loader)
- load
  
  Resource load(URI target) throws ResourceLoadingException
  
  Throws:
  
  ResourceLoadingException
- load
  
  Resource load(URI target, URI relativeTo) throws ResourceLoadingException
  
  Throws:
  
  ResourceLoadingException
- load
  
  Resource load(String target, URI relativeTo) throws ResourceLoadingException
  
  Throws:
  
  ResourceLoadingException
- getLoaders
  
  List<ResourceLoader> getLoaders()
- create
  
  CreateHandle create(CreateRequest toCreate) throws CreateException
  
  Make a request to store a resource according to the given request.
  
  Returns:
  
  an object that has methods for completing a "transaction" for storing the data.
  
  Throws:
  
  CreateException - if the request could not be satisfied. The Problem attached should be able to be shown to a user for them to decide if it can be re-attempted etc. Implementors should try and validate as many preconditions for success in this method as possible.
- create
  
  default CreateHandle create(CreateRequest toCreate, String name, String contentType) throws CreateException
  
  Convenience version of create that calls create(CreateRequest) with a new request, derived from the given request and the given name and content type.
  
  Throws:
  
  CreateException