Package com.inrupt.client.accessgrant

Class AccessRequest.RequestParameters

java.lang.Object

com.inrupt.client.accessgrant.AccessRequest.RequestParameters

Enclosing class:

AccessRequest

public static class AccessRequest.RequestParameters
extends Object

A collection of parameters used for creating access requests.

See, in particular, the AccessGrantClient.requestAccess(RequestParameters) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccessRequest.RequestParameters.Builder	A class for building access request parameters.

Method Summary

Modifier and Type	Method	Description
Instant	getExpiration()	Get the requested expiration date used with an access request operation.
Instant	getIssuedAt()	Get the requested issuance date used with an access request operation.
Set<String>	getModes()	Get the access modes used with an access request operation.
Set<URI>	getPurposes()	Get the purpose identifiers used with an access request operation.
URI	getRecipient()	Get the recipient used with an access request operation.
Set<URI>	getResources()	Get the resources used with an access request operation.
static AccessRequest.RequestParameters.Builder	newBuilder()	Create a new AccessRequest.RequestParameters builder.

Methods inherited from class java.lang.Object

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

Method Details

getRecipient

public URI getRecipient()

Get the recipient used with an access request operation.

Note: the recipient will typically be the resource owner

Returns:

the recipient's identifier

getResources

public Set<URI> getResources()

Get the resources used with an access request operation.

Returns:

the resource idnetifiers

getModes

public Set<String> getModes()

Get the access modes used with an access request operation.

Returns:

the access modes

getPurposes

public Set<URI> getPurposes()

Get the purpose identifiers used with an access request operation.

Returns:

the purpose identifiers

getExpiration

public Instant getExpiration()

Get the requested expiration date used with an access request operation.

Note: an access grant server may select a different expiration date

Returns:

the requested expiration date

getIssuedAt

public Instant getIssuedAt()

Get the requested issuance date used with an access request operation.

Note: an access grant server may select a different issuance date

Returns:

the requested issuance date

newBuilder

public static AccessRequest.RequestParameters.Builder newBuilder()

Create a new AccessRequest.RequestParameters builder.

Returns:

the new builder