Package com.janeirodigital.shapetrees.client.okhttp

Class OkHttpResourceAccessor

java.lang.Object

com.janeirodigital.shapetrees.client.okhttp.OkHttpResourceAccessor

All Implemented Interfaces:

ResourceAccessor

public class OkHttpResourceAccessor
extends Object
implements ResourceAccessor

Allows the shapetrees-core to access ManageableInstances and InstanceResources over the network via HTTP. This is particularly effective when employing client-side shape-tree validation in a proxy scenario.

Given the fact that resources are accessed via HTTP, some inferences must be made on resource state based on responses to HTTP requests.

Constructor Summary

Constructors

Constructor	Description
OkHttpResourceAccessor()

Method Summary

Modifier and Type	Method	Description
InstanceResource	createResource(ShapeTreeContext context, URL url, ResourceAttributes attributes, String body, String contentType)	Create a InstanceResource at the provided url via the provided HTTP method.
DocumentResponse	deleteResource(ShapeTreeContext context, InstanceResource deleteResource)	Deletes the provided InstanceResourcedeleteResource
InstanceResource	getResource(ShapeTreeContext context, URL url)	Get a InstanceResource at the provided url, which may or may not exist.
DocumentResponse	updateResource(ShapeTreeContext context, InstanceResource updateResource, String body)	Updates the provided InstanceResource updateResource with body via the supplied method

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OkHttpResourceAccessor

public OkHttpResourceAccessor()

Method Details

getResource

public InstanceResource getResource(ShapeTreeContext context,
 URL url)
                             throws ShapeTreeException

Get a InstanceResource at the provided url, which may or may not exist. Most of the work happens in generateResource(URL, DocumentResponse), which processes the response and returns the corresponding typed resource.

Specified by:

getResource in interface ResourceAccessor

Parameters:

context - ShapeTreeContext

url - Url of the resource to get

Returns:

InstanceResource

Throws:

ShapeTreeException

createResource

public InstanceResource createResource(ShapeTreeContext context,
 URL url,
 ResourceAttributes attributes,
 String body,
 String contentType)
                                throws ShapeTreeException

Create a InstanceResource at the provided url via the provided HTTP method. Most of the work happens in generateResource(URL, DocumentResponse), which processes the response and returns the corresponding typed resource.

Specified by:

createResource in interface ResourceAccessor

Parameters:

context - ShapeTreeContext

url - Url of the resource to create

attributes - HTTP attributes to use for resource creation

body - Body of resource to create

contentType - HTTP content-type

Returns:

InstanceResource

Throws:

ShapeTreeException

updateResource

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

Updates the provided InstanceResource updateResource with body via the supplied method

Specified by:

updateResource in interface ResourceAccessor

Parameters:

context - Shape tree context

updateResource - InstanceResource to update

body - Body to use for update

Returns:

DocumentResponse of the result

Throws:

ShapeTreeException

deleteResource

public DocumentResponse deleteResource(ShapeTreeContext context,
 InstanceResource deleteResource)
                                throws ShapeTreeException

Deletes the provided InstanceResourcedeleteResource

Specified by:

deleteResource in interface ResourceAccessor

Parameters:

context - ShapeTreeContext

deleteResource - InstanceResource to delete

Returns:

DocumentResponse of the result

Throws:

ShapeTreeException