Shared/com.erfangholami.androidsolidservices.shared.model.profile/WebId

WebId

Represents a Solid WebID identity document — both for reading profile data and for constructing or updating it.

A WebID document is an RDF resource that describes an agent. It MUST contain:

rdf:type foaf:Agent
pim:preferencesFile pointing to the agent's preferences file

It MAY contain:

pim:storage (one or more storage roots)
ldp:inbox (notification inbox)
rdfs:seeAlso (extended profile documents)
foaf:isPrimaryTopicOf
solid:oidcIssuer (OIDC identity provider)
FOAF name / given name / family name / photo
foaf:knows (social graph)
acl:trustedApp (trusted client applications)
cert:key (public key for WebID-TLS)

Use getMetadata (from SolidRDFResource) to access the ETag, ACL URI, and allowed methods returned by the server — useful for conditional PUT updates.

Spec: https://solid.github.io/webid-profile/

Constructors

WebId

constructor(identifier: String, quads: List<RdfQuad>)

constructor(identifier: String, contentType: String, quads: List<RdfQuad>)

constructor(identifier: String, contentType: String, quads: List<RdfQuad>, headers: SolidHeaders?)

Types

Companion

object Companion

Functions

addQuad

fun addQuad(subject: String, predicate: String, obj: String, maxNumber: Int = 1)

Adds a triple whose object is an IRI (or blank node).

addQuadLiteral

fun addQuadLiteral(subject: String, predicate: String, value: String, datatype: String? = XSD.STRING, language: String? = null, maxNumber: Int = 1)

Adds a triple whose object is a literal.

clearProperties

fun clearProperties(predicate: String, subject: String = itselfSubject)

Removes every triple with the given predicate for subject.

open override fun close()

describeContents

open override fun describeContents(): Int

ensureType

fun ensureType(subject: String, typeIri: String)

Ensures subject carries an rdf:type triple with typeIri, preserving any other type triples already present.

findAllProperties

fun findAllProperties(predicate: String): List<String>

Returns the object values of every triple with the given predicate, across all subjects.

findAllPropertiesForSubject

fun findAllPropertiesForSubject(subject: String, predicate: String): List<String>

Returns the object values of every triple matching the given subject and predicate.

findProperty

fun findProperty(predicate: String): String?

Returns the object value of the first triple with the given predicate, or null if none.

findPropertyForSubject

fun findPropertyForSubject(subject: String, predicate: String): String?

Returns the object value of the first triple matching subject and predicate, or null.

getAllQuads

fun getAllQuads(): List<RdfQuad>

Returns a snapshot copy of all triples held by this resource.

getCertKeys

fun getCertKeys(): List<String>

Returns all cert:key public-key URIs listed in this profile.

getContentType

open override fun getContentType(): String

The media type of the resource representation (the value of its Content-Type).

getCreatedTime

fun getCreatedTime(): Long?

The creation time in epoch milliseconds, from this resource's own dcterms:created (then stat:ctime) triple, or null when neither is present.

getEntity

open override fun getEntity(): InputStream

Returns the resource representation as a byte stream.

getFamilyName

fun getFamilyName(): String?

Returns the foaf:familyName literal, or null if not declared.

getGivenName

fun getGivenName(): String?

Returns the foaf:givenName literal, or null if not declared.

getHeaders

open override fun getHeaders(): SolidHeaders

The HTTP headers associated with this resource (empty when constructed locally).

getIdentifier

open override fun getIdentifier(): String

The URI that identifies this resource on the pod.

getInbox

fun getInbox(): String?

Returns the ldp:inbox URI, or null if not declared.

getKnows

fun getKnows(): List<String>

Returns all foaf:knows WebID URIs listed in this profile.

getLastModified

fun getLastModified(): Long?

The last-modified time in epoch milliseconds. Prefers this resource's own dcterms:modified (then stat:mtime) triple and falls back to the Last-Modified header. null when none is present.

getMetadata

open override fun getMetadata(): SolidMetadata

getName

fun getName(): String?

Returns the foaf:name literal, or null if not declared.

getOidcIssuers

fun getOidcIssuers(): List<String>

Returns all solid:oidcIssuer URIs declared in this profile.

getPhoto

fun getPhoto(): String?

Returns the foaf:img photo URI, or null if not declared.

getPreferencesFile

fun getPreferencesFile(): String?

Returns the pim:preferencesFile URI, or null if not declared.

getPrimaryTopicDocuments

fun getPrimaryTopicDocuments(): List<String>

Returns all foaf:isPrimaryTopicOf document URIs.

getPrivateTypeIndex

fun getPrivateTypeIndex(): String?

Returns the solid:privateTypeIndex URI, or null if not declared.

getPublicTypeIndex

fun getPublicTypeIndex(): String?

Returns the solid:publicTypeIndex URI, or null if not declared.

getRelatedResources

fun getRelatedResources(): List<String>

Returns all rdfs:seeAlso (extended profile) document URIs.

getSize

fun getSize(): Long

The size of this resource in bytes (its Content-Length), or 0 when the server did not report one.

getStorages

fun getStorages(): List<String>

Returns all pim:storage root URIs declared in this profile.

getTrustedApps

fun getTrustedApps(): List<String>

Returns all acl:trustedApp URIs listed in this profile.

getTypes

fun getTypes(): List<String>

Returns all rdf:type values declared in this profile.

setInbox

fun setInbox(webId: String, storage: String, uri: String = "/inbox/")

Adds an ldp:inbox triple to this profile document.

setOidcIssuer

fun setOidcIssuer(webId: String, issuerUri: String)

Adds a solid:oidcIssuer triple to this profile document.

setPreferencesFile

fun setPreferencesFile(webId: String, storage: String, uri: String = "/settings/prefs.ttl")

Adds a pim:preferencesFile triple to this profile document.

setPrivateTypeIndex

fun setPrivateTypeIndex(webId: String, storage: String, uri: String = "/settings/privateTypeIndex")

Adds a solid:privateTypeIndex triple to this profile document.

setPublicTypeIndex

fun setPublicTypeIndex(webId: String, storage: String, uri: String = "/settings/publicTypeIndex")

Adds a solid:publicTypeIndex triple to this profile document.

setStorage

fun setStorage(webId: String, storageUri: String)

Adds a pim:storage triple to this profile document.

writeToParcel

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