Shared/com.erfangholami.androidsolidservices.shared.model.resource/SolidMetadata

SolidMetadata

data class SolidMetadata(val aclUri: String?, val storageDescriptionUri: String?, val ownerUri: String?, val wacAllow: WacAllow?, val allowedMethods: Set<String>, val linkTypes: Set<String>, val etag: String?, val lastModified: String?, val location: String?, val contentType: String?, val contentLength: Long, val describeByUri: String?, val acceptPatch: List<String>, val acceptPost: List<String>, val acceptPut: List<String>, val wwwAuthenticate: String?, val oidcIssuerUri: String?, val isStorage: Boolean, val inboxUri: String? = null) : Parcelable

Solid-specific metadata extracted from HTTP response headers for a resource retrieved from a Solid server.

Each field corresponds to a header defined by the Solid Protocol or a spec it builds on:

aclUri — Solid Protocol auxiliary resources: Link: rel="acl"
storageDescriptionUri — Solid Protocol: Link: rel="storageDescription"
ownerUri — Solid Protocol: Link: rel="solid:owner"
wacAllow — Web Access Control: WAC-Allow header
allowedMethods — HTTP + Solid Protocol: Allow header
linkTypes — LDP + Solid Protocol: Link: rel="type" header
etag — HTTP: ETag header
oidcIssuerUri — Solid-OIDC: Link: rel="solid:oidcIssuer"
isStorage — Solid Protocol: derived from Link: rel="type" <pim:Storage>

The packaging of these fields into a single class is an implementation convenience and is not defined by any Solid spec.

Constructors

SolidMetadata

constructor(aclUri: String?, storageDescriptionUri: String?, ownerUri: String?, wacAllow: WacAllow?, allowedMethods: Set<String>, linkTypes: Set<String>, etag: String?, lastModified: String?, location: String?, contentType: String?, contentLength: Long, describeByUri: String?, acceptPatch: List<String>, acceptPost: List<String>, acceptPut: List<String>, wwwAuthenticate: String?, oidcIssuerUri: String?, isStorage: Boolean, inboxUri: String? = null)

Types

Companion

object Companion

Properties

acceptPatch

val acceptPatch: List<String>

Media types accepted for PATCH requests. From Accept-Patch header.

acceptPost

val acceptPost: List<String>

Media types accepted for POST requests. From Accept-Post header.

acceptPut

val acceptPut: List<String>

Media types accepted for PUT requests. From Accept-Put header.

aclUri

val aclUri: String?

URI of the WAC/ACP access-control resource. From Link: rel="acl".

allowedMethods

val allowedMethods: Set<String>

HTTP methods the server accepts for this resource. From Allow header.

contentLength

val contentLength: Long

Size of the resource body in bytes. From Content-Length header. -1 if absent.

contentType

val contentType: String?

Media type of the resource. From Content-Type header.

describeByUri

val describeByUri: String?

URI of the resource that describes this resource. From Link: rel="describedby".

etag

val etag: String?

ETag for cache validation and conditional requests. From ETag header.

inboxUri

val inboxUri: String?

URI of the LDN inbox advertised by Link: rel="http://www.w3.org/ns/ldp#inbox". Used as a fallback when a WebID's profile body doesn't carry an ldp:inbox predicate, since the inbox may be exposed either way.

isStorage

val isStorage: Boolean

Whether this resource is a Solid pod storage root. True when Link: rel="type" <http://www.w3.org/ns/pim/space#Storage> is present.

lastModified

val lastModified: String?

Last-Modified timestamp string. From Last-Modified header.

linkTypes

val linkTypes: Set<String>

RDF type IRIs advertised via Link: <iri>; rel="type" headers. Common values: ldp:Resource, ldp:BasicContainer, pim:Storage.

location

val location: String?

Location URI set on 201 Created responses. From Location header.

oidcIssuerUri

val oidcIssuerUri: String?

OIDC issuer URI for this resource or WebID. From Link: <iri>; rel="http://www.w3.org/ns/solid/terms#oidcIssuer". Spec: https://solidproject.org/TR/oidc

ownerUri

val ownerUri: String?

URI of the storage owner. From Link: rel="solid:owner".

storageDescriptionUri

val storageDescriptionUri: String?

URI of the storage description resource. From Link: rel="storageDescription".

wacAllow

val wacAllow: WacAllow?

Parsed WAC-Allow header — what modes the current caller has on this resource.

wwwAuthenticate

val wwwAuthenticate: String?

WWW-Authenticate challenge. From WWW-Authenticate header. Present on 401 responses.

Functions

describeContents

open override fun describeContents(): Int

writeToParcel

open override fun writeToParcel(dest: Parcel, flags: Int)