ai.agnos.sparql.stream.client.SparqlClientConstants.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of reactive-sparql_2.12 Show documentation
reactive-sparql
The newest version!
package ai.agnos.sparql.stream.client

import akka.http.scaladsl.model.MediaType.NotCompressible
import akka.http.scaladsl.model.{ContentType, HttpCharsets, MediaType}
import org.eclipse.rdf4j.model.{ModelFactory, ValueFactory}
import org.eclipse.rdf4j.model.impl.{LinkedHashModelFactory, SimpleValueFactory}

/*           */
/* CONSTANTS */
/* --------- */
/**
  * Sparql Client Constants
  *
  * The ones referring to parameters and paths are all standardised and should work
  * for any triple store.
  * @see [[https://www.w3.org/TR/sparql11-protocol/]]
  *
  * Tested with Jena Fuseki 2.4.0 and Stardog 3.4.X through 4.2.2
  */
object SparqlClientConstants {

  val QUERY_URI_PART = "/query"
  val QUERY_PARAM_NAME = "query"
  val REASONING_PARAM_NAME = "reasoning"

  val UPDATE_URI_PART = "/update"
  val UPDATE_PARAM_NAME = "update"

  val GRAPH_PARAM_NAME = "graph"

  val DEFAULT_PARAM_NAME = "default"

  val FORM_MIME_TYPE = "x-www-form-urlencoded"
  val SPARQL_RESULTS_MIME_TYPE = "sparql-results+json"
  val TEXT_BOOLEAN_MIME_TYPE = "boolean"

  /**
    * Media type for Form upload
    */
  val `application/x-www-form-urlencoded`: ContentType.NonBinary =
    MediaType.applicationWithFixedCharset(
      FORM_MIME_TYPE,
      HttpCharsets.`UTF-8`
    ).toContentType

  /**
    * Media type for Sparql JSON protocol
    */
  val `application/sparql-results+json`: ContentType.NonBinary =
    MediaType.applicationWithFixedCharset(
      SPARQL_RESULTS_MIME_TYPE,
      HttpCharsets.`UTF-8`
    ).toContentType

  /**
    * Media type for text/boolean
    */
  val `text/boolean`: ContentType.NonBinary = {
    MediaType.text(TEXT_BOOLEAN_MIME_TYPE).toContentType(HttpCharsets.`UTF-8`)
  }

  /**
    * Content Type for application/ld+json
    */
  val `application/ld+json`: ContentType.NonBinary = {
    MediaType.applicationWithFixedCharset("ld+json", HttpCharsets.`UTF-8`).toContentType
  }

  /**
    * Content Types for text/x-nquads and application/n-quads
    */
  val `text/x-nquads`: ContentType.NonBinary = {
    MediaType.text("x-nquads").toContentType(HttpCharsets.`UTF-8`)
  }
  val `application/n-quads`: ContentType.NonBinary = {
    MediaType.applicationWithFixedCharset("n-quads", HttpCharsets.`UTF-8`).toContentType
  }

  /**
    * Content Type for application/n-triples
    */
  val `application/n-triples`: ContentType.NonBinary = {
    MediaType.applicationWithFixedCharset("n-triples", HttpCharsets.`UTF-8`).toContentType
  }

  /**
    * Content Type for application/n-triples
    */
  val `application/octet-stream`: ContentType.Binary = {
    MediaType.applicationBinary("octet-stream", NotCompressible).toContentType
  }

  /**
    * Content Type for text/turtle
    */
  val `text/turtle`: ContentType.NonBinary = {
    MediaType.text("turtle").toContentType(HttpCharsets.`UTF-8`)
  }

  /**
    * Checks the number of available CPU cores from the JVM runtime. Used parallelise async stream operations.
    */
  lazy val numberOfCpuCores: Int = sys.runtime.availableProcessors()

  /**
    * RDF4J Value Factory
    */
  lazy val valueFactory: ValueFactory = SimpleValueFactory.getInstance()

  lazy val modelFactory: ModelFactory = new LinkedHashModelFactory()


}