Package com.janeirodigital.shapetrees.core.resources

Interface ResourceAccessor

All Known Implementing Classes:

OkHttpResourceAccessor

public interface ResourceAccessor

Interface used by the shape trees core for accessing individual InstanceResources.

Depending upon the context, this could be implemented by a ResourceAccessor implementation accessing a database or filesystem (typical of server-side processing), or by a ResourceAccessor implementation that is working with remote resources over http (typical of client-side processing).

Method Summary

Modifier and Type	Method	Description
InstanceResource	createResource(ShapeTreeContext context, URL resourceUrl, ResourceAttributes headers, String body, String contentType)	Creates a specific InstanceResource identified by the provided resourceUrl.
DocumentResponse	deleteResource(ShapeTreeContext context, InstanceResource deleteResource)	Deletes a specific InstanceResource identified by the provided updatedResource
InstanceResource	getResource(ShapeTreeContext context, URL resourceUrl)	Gets a specific InstanceResource identified by the provided resourceUrl.
DocumentResponse	updateResource(ShapeTreeContext context, InstanceResource updatedResource, String body)	Updates a specific InstanceResource identified by the provided updatedResource

Method Details

getResource

InstanceResource getResource(ShapeTreeContext context,
 URL resourceUrl)
                      throws ShapeTreeException

Gets a specific InstanceResource identified by the provided resourceUrl.

Parameters:

context - ShapeTreeContext

resourceUrl - URL of the target resource to get

Returns:

InstanceResource

Throws:

ShapeTreeException

createResource

InstanceResource createResource(ShapeTreeContext context,
 URL resourceUrl,
 ResourceAttributes headers,
 String body,
 String contentType)
                         throws ShapeTreeException

Creates a specific InstanceResource identified by the provided resourceUrl.

Parameters:

context - ShapeTreeContext

resourceUrl - URL of the resource to create

headers - Incoming HTTP headers

body - Body of the resource to create

contentType - Content-type of the resource to create

Returns:

InstanceResource

Throws:

ShapeTreeException

updateResource

DocumentResponse updateResource(ShapeTreeContext context,
 InstanceResource updatedResource,
 String body)
                         throws ShapeTreeException

Updates a specific InstanceResource identified by the provided updatedResource

Parameters:

context - ShapeTreeContext

updatedResource - InstanceResource to update

body - Updated body of the InstanceResource

Returns:

Updated InstanceResource

Throws:

ShapeTreeException

deleteResource

DocumentResponse deleteResource(ShapeTreeContext context,
 InstanceResource deleteResource)
                         throws ShapeTreeException

Deletes a specific InstanceResource identified by the provided updatedResource

Parameters:

context - ShapeTreeContext

deleteResource - InstanceResource to delete

Returns:

Resultant DocumentResponse

Throws:

ShapeTreeException