com.inrupt.client.webid.WebIdProfile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of inrupt-client-webid Show documentation
WebID Profile integration for the Inrupt Java Client Libraries.
The newest version!
/*
 * Copyright 2023 Inrupt Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
 * Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package com.inrupt.client.webid;

import com.inrupt.client.RDFSource;
import com.inrupt.client.vocabulary.PIM;
import com.inrupt.client.vocabulary.RDF;
import com.inrupt.client.vocabulary.RDFS;
import com.inrupt.client.vocabulary.Solid;
import com.inrupt.rdf.wrapping.commons.TermMappings;
import com.inrupt.rdf.wrapping.commons.ValueMappings;
import com.inrupt.rdf.wrapping.commons.WrapperIRI;

import java.net.URI;
import java.util.Set;

import org.apache.commons.rdf.api.Dataset;
import org.apache.commons.rdf.api.Graph;
import org.apache.commons.rdf.api.IRI;
import org.apache.commons.rdf.api.RDFTerm;

/**
 * A WebID Profile for use with Solid.
 */
public class WebIdProfile extends RDFSource {

    private final IRI rdfType;
    private final IRI oidcIssuer;
    private final IRI seeAlso;
    private final IRI storage;

    /**
     * Create a new WebID profile resource.
     *
     * @param identifier the webid URI
     * @param dataset the webid profile dataset
     */
    public WebIdProfile(final URI identifier, final Dataset dataset) {
        super(identifier, dataset);

        this.rdfType = rdf.createIRI(RDF.type.toString());
        this.oidcIssuer = rdf.createIRI(Solid.oidcIssuer.toString());
        this.seeAlso = rdf.createIRI(RDFS.seeAlso.toString());
        this.storage = rdf.createIRI(PIM.storage.toString());
    }

    /**
     * Retrieve the RDF type values.
     *
     * @return the {@code rdf:type} values
     */
    public Set getType() {
        return new Node(rdf.createIRI(getIdentifier().toString()), getGraph()).getType();
    }

    /**
     * Retrieve the list of OIDC issuers.
     *
     * @return the {@code solid:oidcIssuer} values
     */
    public Set getOidcIssuer() {
        return new Node(rdf.createIRI(getIdentifier().toString()), getGraph()).getOidcIssuer();
    }

    /**
     * Retrieve the list of related profile resources.
     *
     * @return the {@code rdfs:seeAlso} values
     */
    public Set getSeeAlso() {
        return new Node(rdf.createIRI(getIdentifier().toString()), getGraph()).getSeeAlso();
    }

    /**
     * Retrieve the list of storage locations.
     *
     * @return the {@code pim:storage} values
     */
    public Set getStorage() {
        return new Node(rdf.createIRI(getIdentifier().toString()), getGraph()).getStorage();
    }

    class Node extends WrapperIRI {

        Node(final RDFTerm original, final Graph graph) {
            super(original, graph);
        }

        Set getType() {
            return objects(rdfType, TermMappings::asIri, ValueMappings::iriAsUri);
        }

        Set getOidcIssuer() {
            return objects(oidcIssuer, TermMappings::asIri, ValueMappings::iriAsUri);
        }

        Set getSeeAlso() {
            return objects(seeAlso, TermMappings::asIri, ValueMappings::iriAsUri);
        }

        Set getStorage() {
            return objects(storage, TermMappings::asIri, ValueMappings::iriAsUri);
        }
    }
}