Package com.janeirodigital.sai.core.authorizations

Class DataAuthorization

java.lang.Object

com.janeirodigital.sai.core.resources.ReadableResource

com.janeirodigital.sai.core.resources.ImmutableResource

com.janeirodigital.sai.core.authorizations.DataAuthorization

public class DataAuthorization
extends ImmutableResource

Immutable instantiation of an Data Authorization

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataAuthorization.Builder	Builder for DataAuthorization instances.

Field Summary

Fields inherited from class com.janeirodigital.sai.core.resources.ReadableResource

contentType, dataset, exists, httpClient, jsonLdContext, resource, saiSession, unprotected, uri

Method Summary

Modifier and Type	Method	Description
protected boolean	canCreate()	Denotes whether the grantee can create new resources based on the assigned permission modes
List<DataGrant>	generateGrants(AccessAuthorization accessAuthorization, AgentRegistration granteeRegistration, AgentRegistry agentRegistry, List<DataRegistry> dataRegistries)	Generate one or more DataGrants for this DataAuthorization.
static DataAuthorization	get(URI uri, SaiSession saiSession)	Call get(URI, SaiSession, ContentType) without specifying a desired content type for retrieval
static DataAuthorization	get(URI uri, SaiSession saiSession, com.janeirodigital.sai.httputils.ContentType contentType)	Get a DataAuthorization at the provided uri
DataAuthorization	reload()	Reload a new instance of DataAuthorization using the attributes of the current instance

Methods inherited from class com.janeirodigital.sai.core.resources.ImmutableResource

create, delete

Methods inherited from class com.janeirodigital.sai.core.resources.ReadableResource

checkReadableResponse, read

Methods inherited from class java.lang.Object

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

Method Details

get

public static DataAuthorization get(URI uri,
 SaiSession saiSession,
 com.janeirodigital.sai.httputils.ContentType contentType)
                             throws SaiException,
com.janeirodigital.sai.httputils.SaiHttpNotFoundException

Get a DataAuthorization at the provided uri

Parameters:

uri - URI of the DataAuthorization to get

saiSession - SaiSession to assign

contentType - ContentType to use

Returns:

Retrieved DataAuthorization

Throws:

SaiException

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

get

public static DataAuthorization get(URI uri,
 SaiSession saiSession)
                             throws SaiException,
com.janeirodigital.sai.httputils.SaiHttpNotFoundException

Call get(URI, SaiSession, ContentType) without specifying a desired content type for retrieval

Parameters:

uri - URI of the DataAuthorization to get

saiSession - SaiSession to assign

Returns:

Retrieved DataAuthorization

Throws:

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

SaiException

reload

public DataAuthorization reload()
                         throws SaiException,
com.janeirodigital.sai.httputils.SaiHttpNotFoundException

Reload a new instance of DataAuthorization using the attributes of the current instance

Returns:

Reloaded DataAuthorization

Throws:

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

SaiException

generateGrants

public List<DataGrant> generateGrants(AccessAuthorization accessAuthorization,
 AgentRegistration granteeRegistration,
 AgentRegistry agentRegistry,
 List<DataRegistry> dataRegistries)
                               throws SaiException,
com.janeirodigital.sai.httputils.SaiHttpNotFoundException

Generate one or more DataGrants for this DataAuthorization.

Returns:

List of generated DataGrants

Throws:

SaiException

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

canCreate

protected boolean canCreate()

Denotes whether the grantee can create new resources based on the assigned permission modes

Returns:

true when grantee can create