Package com.janeirodigital.sai.core.resources

Class ReadableResource

java.lang.Object

com.janeirodigital.sai.core.resources.ReadableResource

Direct Known Subclasses:

CRUDResource, ImmutableResource, ReadableAccessGrant, ReadableAgentRegistration, ReadableApplicationProfile, ReadableDataGrant, ReadableDataRegistration, ReadableSocialAgentProfile

public class ReadableResource
extends Object

Represents a corresponding RDF Resource and provides read-only capabilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadableResource.Builder<T extends ReadableResource.Builder<T>>	Generic builder which is extended by readable resource builders, as well as builders for the other base resource types CRUDResource and ImmutableResource, respectively.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.janeirodigital.sai.httputils.ContentType	contentType
protected org.apache.jena.rdf.model.Model	dataset
protected boolean	exists
protected final okhttp3.OkHttpClient	httpClient
protected String	jsonLdContext
protected org.apache.jena.rdf.model.Resource	resource
protected final SaiSession	saiSession
protected boolean	unprotected
protected final URI	uri

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReadableResource(ReadableResource.Builder<?> builder)	Construct a Readable resource using the provided ReadableResource.Builder.

Method Summary

Modifier and Type	Method	Description
static okhttp3.Response	checkReadableResponse(okhttp3.Response response)	Checks the response when fetching data for a readable resource
protected static okhttp3.Response	read(URI uri, SaiSession saiSession, com.janeirodigital.sai.httputils.ContentType contentType, boolean unprotected)	Reads the remote RDF resource at uri, providing credentials from the SaiSession when unprotected is not true.

Methods inherited from class java.lang.Object

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

Field Details

uri

protected final URI uri

saiSession

protected final SaiSession saiSession

httpClient

protected final okhttp3.OkHttpClient httpClient

dataset

protected org.apache.jena.rdf.model.Model dataset

resource

protected org.apache.jena.rdf.model.Resource resource

contentType

protected com.janeirodigital.sai.httputils.ContentType contentType

jsonLdContext

protected String jsonLdContext

unprotected

protected boolean unprotected

exists

protected boolean exists

Constructor Details

ReadableResource

protected ReadableResource(ReadableResource.Builder<?> builder)
                    throws SaiException

Construct a Readable resource using the provided ReadableResource.Builder.

Parameters:

builder - ReadableResource.Builder or an instance of an inheriting subclass

Throws:

SaiException

Method Details

read

protected static okhttp3.Response read(URI uri,
 SaiSession saiSession,
 com.janeirodigital.sai.httputils.ContentType contentType,
 boolean unprotected)
                                throws SaiException,
com.janeirodigital.sai.httputils.SaiHttpNotFoundException

Reads the remote RDF resource at uri, providing credentials from the SaiSession when unprotected is not true.

Parameters:

uri - URI to GET

saiSession - SaiSession to use

contentType - ContentType to accept

unprotected - When true, does not send authorization headers

Returns:

OkHttp Response

Throws:

SaiException

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

checkReadableResponse

public static okhttp3.Response checkReadableResponse(okhttp3.Response response)
                                              throws com.janeirodigital.sai.httputils.SaiHttpNotFoundException,
SaiException

Checks the response when fetching data for a readable resource

Parameters:

response - Response to check

Returns:

Checked Response

Throws:

com.janeirodigital.sai.httputils.SaiHttpNotFoundException - when the resource cannot be found (HTTP 404)

SaiException - when the response code is unsuccessful for any other reason