Installation

To use Inrupt’s Java client library, add the inrupt-client-bom and specific library modules to your Maven or Gradle project.

1. Add inrupt-client-bom

Maven

To your project’s pom.xml:

1. Add the inrupt-client-bom dependency in the project’s <dependencyManagement> section.

2. Replace SUBSTITUTE_VERSION with the version to use.

<dependencyManagement>
   <dependencies>
      <dependency>
         <groupId>com.inrupt.client</groupId>
         <artifactId>inrupt-client-bom</artifactId>
         <version>SUBSTITUTE_VERSION</version>
         <type>pom</type>
         <scope>import</scope>
      </dependency>
   </dependencies>
</dependencyManagement>

For the latest version of inrupt-client-bom,

1. Go to Maven Central.

2. Search for inrupt-client-bom. Get the version for the package with com.inrupt.client namespace.

Gradle (Groovy)

To your project’s build script build.gradle:

1. Add the inrupt-client-bom platform dependency.

2. Replace SUBSTITUTE_VERSION with the version to use.

dependencies {
    implementation platform("com.inrupt.client:inrupt-client-bom:SUBSTITUTE_VERSION")
}

For the latest version of inrupt-client-bom,

1. Go to Maven Central.

2. Search for inrupt-client-bom. Get the version for the package with com.inrupt.client namespace.

Gradle (Kotlin)

To your project’s build script build.gradle.kts:

1. Add the inrupt-client-bom platform dependency.

2. Replace SUBSTITUTE_VERSION with the version to use.

dependencies {
    //... additional dependencies
    implementation(platform("com.inrupt.client:inrupt-client-bom:SUBSTITUTE_VERSION"))
}

For the latest version of inrupt-client-bom,

1. Go to Maven Central.

2. Search for inrupt-client-bom. Get the version for the package with com.inrupt.client namespace.

2. Add Specific Module Dependencies

Maven

To your project’s pom.xml file, you can either:

• Add the inrupt-client-runtime to include all recommended Java Client Libraries runtime modules; or

• Add specific Java Client Libraries modules.

inrupt-client-runtime

To include all recommended runtime modules from the Java Client Libraries, add the following dependency to the <dependencies> section in your project’s pom.xml file.

The recommended modules include those modules used to:

• Access your WebID,

• Perform read and write operations (both RDF and non-RDF resources) on your Pod,

• For the read of RDF resources, return the RDF resources in Turtle and JSON, and

• Use access requests and access grants.

<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-runtime</artifactId>
</dependency>

Specific Modules

To your project’s pom.xml file, add the specific library modules in your project <dependencies> section. The following example includes the modules used to:

• Access your WebID

• Perform read and write operations (both RDF and non-RDF resources) on your Pod, and

• For the read of RDF resources, return the RDF resources in Turtle and JSON, and

• Use access requests and access grants.

<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-api</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-solid</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-core</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-okhttp</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-jackson</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-jena</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-openid</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-accessgrant</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-uma</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-vocabulary</artifactId>
</dependency>
<dependency>
    <groupId>com.inrupt.client</groupId>
    <artifactId>inrupt-client-webid</artifactId>
</dependency>

Inrupt’s Java Client Libraries are composed of different modules. See Library Modules for the list of available modules and their description.

Gradle (Groovy)

To your project’s build script build.gradle, add the specific library modules as module dependencies. The following example includes the modules used to:

• Access your WebID,

• Perform read and write operations (both RDF and non-RDF resources) on your Pod, and

• For the read of RDF resources, return the RDF resources in Turtle and JSON, and

• Use Access Requests and Access Grants.

dependencies {
    implementation platform("com.inrupt.client:inrupt-client-bom:SUBSTITUTE_VERSION")
    implementation "com.inrupt.client:inrupt-client-api"
    implementation "com.inrupt.client:inrupt-client-solid"
    implementation "com.inrupt.client:inrupt-client-core"
    implementation "com.inrupt.client:inrupt-client-okhttp"
    implementation "com.inrupt.client:inrupt-client-jackson"
    implementation "com.inrupt.client:inrupt-client-jena"
    implementation "com.inrupt.client:inrupt-client-accessgrant"
    implementation "com.inrupt.client:inrupt-client-openid"
    implementation "com.inrupt.client:inrupt-client-uma"
    implementation "com.inrupt.client:inrupt-client-vocabulary"
    implementation "com.inrupt.client:inrupt-client-webid"
}

Inrupt’s Java Client Libraries are composed of different modules. See Library Modules for the list of available modules and their description.

Gradle (Kotlin)

To your project’s build script build.gradle.kts, add the specific library modules as module dependencies. The following example includes the modules used to:

• Add the inrupt-client-runtime to include all recommended Java Client Libraries runtime modules; or

• Add specific Java Client Libraries modules.

inrupt-client-runtime

To include all recommended runtime modules from the Java Client Libraries, add the following inrupt-client-runtime dependency. The recommended modules include those modules used to:

• Access your WebID,

• Perform read and write operations (both RDF and non-RDF resources) on your Pod,

• For the read of RDF resources, return the RDF resources in Turtle and JSON, and

• Use Access Requests and Access Grants.

dependencies {
    //... additional dependencies
    implementation(platform("com.inrupt.client:inrupt-client-bom:SUBSTITUTE_VERSION"))
    implementation("com.inrupt.client:inrupt-client-runtime")
}

Specific Modules

You can add specific library modules. The following example includes the modules used to:

• Access your WebID,

• Perform read and write operations (both RDF and non-RDF resources) on your Pod,

• For the read of RDF resources, return the RDF resources in Turtle and JSON, and

• Use Access Requests and Access Grants.

dependencies {
    //... additional dependencies
    implementation(platform("com.inrupt.client:inrupt-client-bom:SUBSTITUTE_VERSION"))
    implementation("com.inrupt.client:inrupt-client-api")
    implementation("com.inrupt.client:inrupt-client-solid")
    implementation("com.inrupt.client:inrupt-client-core")
    implementation("com.inrupt.client:inrupt-client-okhttp")
    implementation("com.inrupt.client:inrupt-client-jackson")
    implementation("com.inrupt.client:inrupt-client-jena")
    implementation("com.inrupt.client:inrupt-client-accessgrant")
    implementation("com.inrupt.client:inrupt-client-openid")
    implementation("com.inrupt.client:inrupt-client-uma")
    implementation("com.inrupt.client:inrupt-client-vocabulary")
    implementation("com.inrupt.client:inrupt-client-webid")
}

Inrupt’s Java Client Libraries are composed of different modules. See Library Modules for the list of available modules and their description.