Package com.janeirodigital.sai.core.authorizations

Class AccessAuthorization

java.lang.Object

com.janeirodigital.sai.core.resources.ReadableResource

com.janeirodigital.sai.core.resources.ImmutableResource

com.janeirodigital.sai.core.authorizations.AccessAuthorization

public class AccessAuthorization
extends ImmutableResource

Immutable instantiation of an Access Authorization

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccessAuthorization.Builder	Builder for AccessAuthorization 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
AccessGrant	generateGrant(AgentRegistration granteeRegistration, AgentRegistry agentRegistry, List<DataRegistry> dataRegistries)	Generate an AccessGrant and its associated DataGrants based on this AccessAuthorization.
static AccessAuthorization	get(URI uri, SaiSession saiSession)	Call get(URI, SaiSession, ContentType) without specifying a desired content type for retrieval
static AccessAuthorization	get(URI uri, SaiSession saiSession, com.janeirodigital.sai.httputils.ContentType contentType)	Get an AccessAuthorization at the provided uri
AccessAuthorization	reload()	Reload a new instance of AccessAuthorization 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 AccessAuthorization get(URI uri,
 SaiSession saiSession,
 com.janeirodigital.sai.httputils.ContentType contentType)
                               throws SaiException,
com.janeirodigital.sai.httputils.SaiHttpNotFoundException

Get an AccessAuthorization at the provided uri

Parameters:

uri - URI of the AccessAuthorization to get

saiSession - SaiSession to assign

contentType - ContentType to use

Returns:

Retrieved AccessAuthorization

Throws:

SaiException

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

get

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

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

Parameters:

uri - URI of the AccessAuthorization to get

saiSession - SaiSession to assign

Returns:

Retrieved AccessAuthorization

Throws:

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

SaiException

reload

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

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

Returns:

Reloaded AccessAuthorization

Throws:

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

SaiException

generateGrant

public AccessGrant generateGrant(AgentRegistration granteeRegistration,
 AgentRegistry agentRegistry,
 List<DataRegistry> dataRegistries)
                          throws SaiException,
com.janeirodigital.sai.httputils.SaiHttpNotFoundException

Generate an AccessGrant and its associated DataGrants based on this AccessAuthorization.

Parameters:

granteeRegistration - AgentRegistration for the grantee

agentRegistry - AgentRegistry for the social agent performing the grant

dataRegistries - List of DataRegistry instances in scope of the authorization

Returns:

Generated AccessGrant

Throws:

SaiException

com.janeirodigital.sai.httputils.SaiHttpNotFoundException