org.eclipse.rdf4j.model.vocabulary.CONFIG Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rdf4j-model-vocabulary Show documentation
Well-Known RDF vocabularies.
The newest version!
/*******************************************************************************
 * Copyright (c) 2023 Eclipse RDF4J contributors.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Distribution License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/org/documents/edl-v10.php
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *******************************************************************************/
package org.eclipse.rdf4j.model.vocabulary;

import static org.eclipse.rdf4j.model.vocabulary.Vocabularies.createIRI;

import org.eclipse.rdf4j.model.IRI;
import org.eclipse.rdf4j.model.Namespace;

/**
 * Shared vocabulary for configuration of RDF4J components: Repositories, SAILs, and so on.
 *
 * @author Jeen Broekstra
 *
 * @since 4.3.0
 */
public class CONFIG {

	/**
	 * The RDF4J config namespace (tag:rdf4j.org,2023:config/).
	 *
	 * @see the 'tag' URI Scheme (RFC 4151)
	 */
	public static final String NAMESPACE = "tag:rdf4j.org,2023:config/";

	/**
	 * The recommended prefix for the RDF4J config namespace: "config"
	 */
	public static final String PREFIX = "config";

	/**
	 * The RDF4J config namespace (tag:rdf4j.org,2023:config/) as a {@link Namespace} object.
	 *
	 * @see the 'tag' URI Scheme (RFC 4151)
	 */
	public static final Namespace NS = Vocabularies.createNamespace(PREFIX, NAMESPACE);

	/**
	 * Setting for linking a delegate config to a wrapper in a SAIL or Repository config stack.
	 *
	 * tag:rdf4j.org,2023:config/delegate
	 */
	public final static IRI delegate = createIRI(NAMESPACE, "delegate");

	/**
	 * Repository config
	 */
	public static final class Rep {
		/**
		 * Type value for a RepositoryConfig.
		 *
		 * tag:rdf4j.org,2023:config/Repository
		 */
		public final static IRI Repository = createIRI(NAMESPACE, "Repository");

		/**
		 * Setting for the repository ID.
		 *
		 * tag:rdf4j.org,2023:config/rep.id
		 */
		public final static IRI id = createIRI(NAMESPACE, "rep.id");

		/**
		 * Setting for the repository implementation-specific configuration.
		 *
		 * tag:rdf4j.org,2023:config/rep.impl
		 */
		public final static IRI impl = createIRI(NAMESPACE, "rep.impl");

		/**
		 * Setting for the repository type.
		 *
		 * tag:rdf4j.org,2023:config/rep.type
		 */
		public final static IRI type = createIRI(NAMESPACE, "rep.type");
	}

	/**
	 * HTTP Repository config
	 */
	public static final class Http {
		/**
		 * Setting for a RDF4J HTTP Repository URL.
		 *
		 * tag:rdf4j.org,2023:config/http.url
		 */
		public static final IRI url = createIRI(NAMESPACE, "http.url");

		/**
		 * Setting for a username to use for authentication.
		 *
		 * tag:rdf4j.org,2023:config/http.username
		 */
		public final static IRI username = createIRI(NAMESPACE, "http.username");

		/**
		 * Setting for a password to use for authentication.
		 *
		 * tag:rdf4j.org,2023:config/http.password
		 */
		public final static IRI password = createIRI(NAMESPACE, "http.password");
	}

	/**
	 * ContextAwareRepository config
	 */
	public static final class ContextAware {
		/**
		 * Setting for including inferred statements by default.
		 *
		 * tag:rdf4j.org,2023:config/ca.includeInferred
		 */
		public final static IRI includeInferred = createIRI(NAMESPACE, "ca.includeInferred");

		/**
		 * Setting for the max query time.
		 *
		 * tag:rdf4j.org,2023:config/ca.maxQueryTime
		 */
		public final static IRI maxQueryTime = createIRI(NAMESPACE, "ca.maxQueryTime");

		/**
		 * Setting for the query language to be used.
		 *
		 * tag:rdf4j.org,2023:config/ca.queryLanguage
		 */
		public final static IRI queryLanguage = createIRI(NAMESPACE, "ca.queryLanguage");
		/**
		 *
		 * tag:rdf4j.org,2023:config/ca.readContext
		 */
		public final static IRI readContext = createIRI(NAMESPACE, "ca.readContext");

		/**
		 * tag:rdf4j.org,2023:config/ca.removeContext
		 */
		public final static IRI removeContext = createIRI(NAMESPACE, "ca.removeContext");

		/**
		 * tag:rdf4j.org,2023:config/ca.insertContext
		 */
		public final static IRI insertContext = createIRI(NAMESPACE, "ca.insertContext");

		/**
		 * Setting for a base URI.
		 *
		 * tag:rdf4j.org,2023:config/ca.base
		 */
		public final static IRI base = createIRI(NAMESPACE, "ca.base");

	}

	/**
	 * ProxyRepository config
	 *
	 */
	public static final class Proxy {
		/**
		 * tag:rdf4j.org,2023:config/proxy.proxiedID
		 */
		public final static IRI proxiedID = createIRI(NAMESPACE, "proxy.proxiedID");

	}

	/**
	 * SPARQLRepository config
	 */
	public static final class Sparql {
		/**
		 * Configuration setting for the SPARQL query endpoint.
		 *
		 * tag:rdf4j.org,2023:config/sparql.queryEndpoint
		 */
		public static final IRI queryEndpoint = createIRI(NAMESPACE, "sparql.queryEndpoint");

		/**
		 * Configuration setting for the SPARQL update endpoint.
		 *
		 * tag:rdf4j.org,2023:config/sparql.updateEndpoint
		 */
		public static final IRI updateEndpoint = createIRI(NAMESPACE, "sparql.updateEndpoint");

		/**
		 * Configuration setting for enabling/disabling direct result pass-through.
		 *
		 * tag:rdf4j.org,2023:config/sparql.passThroughEnabled
		 *
		 * @see SPARQLProtocolSession#isPassThroughEnabled()
		 */
		public static final IRI passThroughEnabled = createIRI(NAMESPACE, "sparql.passThroughEnabled");
	}

	/**
	 * Sail config
	 */
	public static final class Sail {
		/**
		 * tag:rdf4j.org,2023:config/sail.type
		 */
		public final static IRI type = createIRI(NAMESPACE, "sail.type");

		/**
		 * tag:rdf4j.org,2023:config/sail.impl
		 */
		public final static IRI impl = createIRI(NAMESPACE, "sail.impl");

		/**
		 * tag:rdf4j.org,2023:config/sail.iterationCacheSyncTreshold
		 */
		public final static IRI iterationCacheSyncThreshold = createIRI(NAMESPACE,
				"sail.iterationCacheSyncThreshold");

		/**
		 * tag:rdf4j.org,2023:config/sail.connectionTimeOut
		 */
		public final static IRI connectionTimeOut = createIRI(NAMESPACE, "sail.connectionTimeOut");

		/** tag:rdf4j.org,2023:config/sail.evaluationStrategyFactory */
		public final static IRI evaluationStrategyFactory = createIRI(NAMESPACE,
				"sail.evaluationStrategyFactory");

		/** tag:rdf4j.org,2023:config/sail.defaultQueryEvaluationMode */
		public final static IRI defaultQueryEvaluationMode = createIRI(NAMESPACE,
				"sail.defaultQueryEvaluationMode");
	}

	/**
	 * Memory Store config
	 */
	public static final class Mem {
		/** tag:rdf4j.org,2023:config/mem.persist */
		public final static IRI persist = createIRI(NAMESPACE, "mem.persist");

		/** tag:rdf4j.org,2023:config/mem.syncDelay */
		public final static IRI syncDelay = createIRI(NAMESPACE, "mem.syncDelay");
	}

	/**
	 * Native Store config
	 */
	public static final class Native {
		/**
		 * tag:rdf4j.org,2023:config/native.tripleIndexes
		 */
		public final static IRI tripleIndexes = createIRI(NAMESPACE, "native.tripleIndexes");

		/**
		 * tag:rdf4j.org,2023:config/native.forceSync
		 */
		public final static IRI forceSync = createIRI(NAMESPACE, "native.forceSync");

		/**
		 * tag:rdf4j.org,2023:config/native.valueCacheSize
		 */
		public final static IRI valueCacheSize = createIRI(NAMESPACE, "native.valueCacheSize");

		/**
		 * tag:rdf4j.org,2023:config/native.valueIDCacheSize
		 */
		public final static IRI valueIDCacheSize = createIRI(NAMESPACE, "native.valueIDCacheSize");

		/**
		 * tag:rdf4j.org,2023:config/native.namespaceCacheSize
		 */
		public final static IRI namespaceCacheSize = createIRI(NAMESPACE, "native.namespaceCacheSize");

		/**
		 * tag:rdf4j.org,2023:config/native.namespaceIDCacheSize
		 */
		public final static IRI namespaceIDCacheSize = createIRI(NAMESPACE, "native.namespaceIDCacheSize");
	}

	/**
	 * SHACL Sail config
	 */
	public static final class Shacl {
		/**
		 * tag:rdf4j.org,2023:config/shacl.parallelValidation
		 */
		public final static IRI parallelValidation = createIRI(NAMESPACE, "shacl.parallelValidation");

		/**
		 * tag:rdf4j.org,2023:config/shacl.logValidationPlans
		 */
		public final static IRI logValidationPlans = createIRI(NAMESPACE, "shacl.logValidationPlans");

		/**
		 * tag:rdf4j.org,2023:config/shacl.logValidationViolations
		 */
		public final static IRI logValidationViolations = createIRI(NAMESPACE,
				"shacl.logValidationViolations");

		/**
		 * tag:rdf4j.org,2023:config/shacl.validationEnabled
		 */
		public final static IRI validationEnabled = createIRI(NAMESPACE, "shacl.validationEnabled");

		/**
		 * tag:rdf4j.org,2023:config/shacl.cacheSelectNodes
		 */
		public final static IRI cacheSelectNodes = createIRI(NAMESPACE, "shacl.cacheSelectNodes");

		/**
		 * tag:rdf4j.org,2023:config/shacl.globalLogValidationExecution
		 */
		public final static IRI globalLogValidationExecution = createIRI(NAMESPACE,
				"shacl.globalLogValidationExecution");

		/**
		 * tag:rdf4j.org,2023:config/shacl.rdfsSubClassReasoning
		 */
		public final static IRI rdfsSubClassReasoning = createIRI(NAMESPACE,
				"shacl.rdfsSubClassReasoning");

		/**
		 * tag:rdf4j.org,2023:config/shacl.performanceLogging
		 */
		public final static IRI performanceLogging = createIRI(NAMESPACE, "shacl.performanceLogging");

		/**
		 * tag:rdf4j.org,2023:config/shacl.serializableValidation
		 */
		public final static IRI serializableValidation = createIRI(NAMESPACE,
				"shacl.serializableValidation");

		public final static IRI eclipseRdf4jShaclExtensions = createIRI(NAMESPACE,
				"shacl.eclipseRdf4jShaclExtensions");

		public final static IRI dashDataShapes = createIRI(NAMESPACE, "shacl.dashDataShapes");

		public final static IRI validationResultsLimitTotal = createIRI(NAMESPACE,
				"shacl.validationResultsLimitTotal");
		public final static IRI validationResultsLimitPerConstraint = createIRI(NAMESPACE,
				"shacl.validationResultsLimitPerConstraint");
		public final static IRI transactionalValidationLimit = createIRI(NAMESPACE,
				"shacl.transactionalValidationLimit");

		public final static IRI shapesGraph = createIRI(NAMESPACE, "shacl.shapesGraph");
	}

	/**
	 * Lucene Sail config
	 *
	 */
	public static final class Lucene {
		public final static IRI indexDir = createIRI(NAMESPACE, "lucene.indexDir");
	}

	/**
	 * Elasticsearch Store config
	 */
	public static final class Ess {

		public final static IRI hostname = createIRI(NAMESPACE, "ess.hostname");
		public final static IRI port = createIRI(NAMESPACE, "ess.port");
		public final static IRI index = createIRI(NAMESPACE, "ess.index");
		public final static IRI clusterName = createIRI(NAMESPACE, "ess.clusterName");
	}

	/**
	 * Custom Graph Query Inferencer config
	 */
	public static final class Cgqi {
		public final static IRI queryLanguage = createIRI(NAMESPACE, "cgqi.queryLanguage");

		public final static IRI ruleQuery = createIRI(NAMESPACE, "cgqi.ruleQuery");

		public final static IRI matcherQuery = createIRI(NAMESPACE, "cgqi.matcherQuery");
	}

}