org.apache.marmotta.kiwi.config

Class KiWiConfiguration

java.lang.Object

org.apache.marmotta.kiwi.config.KiWiConfiguration

public class KiWiConfiguration
extends Object

An object to hold a KiWi persistence configuration. The configuration consists of:

• a name to identify the persistence configuration throughout the system
• a JDBC URL for connecting to the respective relational database
• a database user to access the database
• a database password for that user
• a KiWi dialect for representing the different SQL dialects

Author: Sebastian Schaffert

Constructor Summary

Constructors

Constructor and Description
KiWiConfiguration(String name, String jdbcUrl, String dbUser, String dbPassword, KiWiDialect dialect)
KiWiConfiguration(String name, String jdbcUrl, String dbUser, String dbPassword, KiWiDialect dialect, String defaultContext, String inferredContext)

Method Summary

Methods

Modifier and Type	Method and Description
int	getBNodeCacheSize() The maximum size of the BNode cache used by the KiWiValueFactory (default: 10000)
CacheMode	getCacheMode() Get the cache mode for this KiWi triple store.
CachingBackends	getCachingBackend() Fully qualified class name of the cache manager factory to use.
String	getClusterAddress() The cluster address serves two purposes, depending on the kind of caching used.
String	getClusterName() Return the name of the cluster.
int	getClusterPort() Return the multicast port used by the cache cluster this triplestore belongs to.
int	getClusterTimeout()
int	getCursorSize() Size of the database cursor for pre-fetching rows on database supporting this feature.
int	getDatacenterId() The datacenter ID of this server for generating unique database IDs.
String	getDbPassword()
String	getDbUser()
String	getDefaultContext()
KiWiDialect	getDialect()
String[]	getFulltextLanguages() Return the languages (ISO codes) for which to add specific fulltext search support.
String	getInferredContext()
String	getJdbcUrl()
int	getLiteralCacheSize() The maximum size of the literal cache used by the KiWiValueFactory (default: 100000)
String	getName()
int	getNamespaceCacheSize() The maximum size of the namespace cache used for looking up namespaces by prefix and uri
int	getNodeCacheSize() The maximum size of the node ID cache used by the KiWiValueFactory (default: 1000000)
RegistryStrategy	getRegistryStrategy() Return the strategy to use for synchronizing between transactions.
int	getTripleBatchSize()
int	getTripleCacheSize() The maximum size of the triple cache used for looking up triples by id
int	getUriCacheSize() The maximum size of the URI cache used by the KiWiValueFactory (default: 500000)
boolean	isClustered() If true, support for special cluster features is enabled (e.g.
boolean	isFulltextEnabled() Return true in case fulltext support is enabled in this configuration.
boolean	isJmxEnabled() Return true if statistics collection in JMX.
boolean	isQueryLoggingEnabled()
boolean	isTripleBatchCommit() Enable batched commit for triples (if supported by the database dialect).
KiWiConfiguration	setBNodeCacheSize(int bNodeCacheSize) The maximum size of the BNode cache used by the KiWiValueFactory (default: 10000)
KiWiConfiguration	setCacheMode(CacheMode cacheMode) Set the cache mode for this KiWi triple store.
KiWiConfiguration	setCachingBackend(CachingBackends cachingBackend) Fully qualified class name of the cache manager factory to use.
KiWiConfiguration	setClusterAddress(String clusterAddress) The cluster address serves two purposes, depending on the kind of caching used.
KiWiConfiguration	setClustered(boolean clustered) If true, support for special cluster features is enabled (e.g.
KiWiConfiguration	setClusterName(String clusterName) Change the name of the cluster.
KiWiConfiguration	setClusterPort(int clusterPort) Change the multicast port used by the cache cluster this triplestore belongs to.
void	setClusterTimeout(int clusterTimeout)
KiWiConfiguration	setCursorSize(int cursorSize) Size of the database cursor for pre-fetching rows on database supporting this feature.
KiWiConfiguration	setDatacenterId(int datacenterId) The datacenter ID of this server for generating unique database IDs.
KiWiConfiguration	setDefaultContext(String defaultContext)
KiWiConfiguration	setFulltextEnabled(boolean fulltextEnabled) Set to true in case fulltext support is enabled in this configuration.
KiWiConfiguration	setFulltextLanguages(List<String> fulltextLanguages) Set the languages (ISO codes) for which to add specific fulltext search support.
KiWiConfiguration	setFulltextLanguages(String[] fulltextLanguages) Set the languages (ISO codes) for which to add specific fulltext search support.
KiWiConfiguration	setInferredContext(String inferredContext)
KiWiConfiguration	setJmxEnabled(boolean jmxEnabled) Enable/disable statistics collection in JMX.
KiWiConfiguration	setLiteralCacheSize(int literalCacheSize) The maximum size of the literal cache used by the KiWiValueFactory (default: 100000)
KiWiConfiguration	setNamespaceCacheSize(int namespaceCacheSize) The maximum size of the namespace cache used for looking up namespaces by prefix and uri
KiWiConfiguration	setNodeCacheSize(int nodeCacheSize) The maximum size of the node ID cache used by the KiWiValueFactory (default: 1000000)
KiWiConfiguration	setQueryLoggingEnabled(boolean queryLoggingEnabled)
KiWiConfiguration	setRegistryStrategy(RegistryStrategy registryStrategy) Change the strategy to use for synchronizing between transactions.
KiWiConfiguration	setTripleBatchCommit(boolean tripleBatchCommit) Enable batched commit for triples (if supported by the database dialect).
KiWiConfiguration	setTripleBatchSize(int tripleBatchSize)
KiWiConfiguration	setTripleCacheSize(int tripleCacheSize) The maximum size of the triple cache used for looking up triples by id
KiWiConfiguration	setUriCacheSize(int uriCacheSize) The maximum size of the URI cache used by the KiWiValueFactory (default: 500000)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KiWiConfiguration

public KiWiConfiguration(String name,
                 String jdbcUrl,
                 String dbUser,
                 String dbPassword,
                 KiWiDialect dialect)

KiWiConfiguration

public KiWiConfiguration(String name,
                 String jdbcUrl,
                 String dbUser,
                 String dbPassword,
                 KiWiDialect dialect,
                 String defaultContext,
                 String inferredContext)

Method Detail

getDbPassword

public String getDbPassword()

getDbUser

public String getDbUser()

getDialect

public KiWiDialect getDialect()

getJdbcUrl

public String getJdbcUrl()

getName

public String getName()

isQueryLoggingEnabled

public boolean isQueryLoggingEnabled()

setQueryLoggingEnabled

public KiWiConfiguration setQueryLoggingEnabled(boolean queryLoggingEnabled)

getDefaultContext

public String getDefaultContext()

setDefaultContext

public KiWiConfiguration setDefaultContext(String defaultContext)

getInferredContext

public String getInferredContext()

setInferredContext

public KiWiConfiguration setInferredContext(String inferredContext)

isTripleBatchCommit

public boolean isTripleBatchCommit()

Enable batched commit for triples (if supported by the database dialect). If this is enabled, the KiWiConnection will use an in-memory buffer for stored triples that are committed in a batch once the limit is reached or the connection committed. Enabling this can significantly improve the performance, and is usually quite safe for triples.

setTripleBatchCommit

public KiWiConfiguration setTripleBatchCommit(boolean tripleBatchCommit)

Enable batched commit for triples (if supported by the database dialect). If this is enabled, the KiWiConnection will use an in-memory buffer for stored triples that are committed in a batch once the limit is reached or the connection committed. Enabling this can significantly improve the performance, and is usually quite safe for triples.

getTripleBatchSize

public int getTripleBatchSize()

setTripleBatchSize

public KiWiConfiguration setTripleBatchSize(int tripleBatchSize)

getCursorSize

public int getCursorSize()

Size of the database cursor for pre-fetching rows on database supporting this feature. If the size is set to 0, no cursor is used and all rows are retrieved in one batch.

See Also:

Statement.setFetchSize(int)

setCursorSize

public KiWiConfiguration setCursorSize(int cursorSize)

Size of the database cursor for pre-fetching rows on database supporting this feature. If the size is set to 0, no cursor is used and all rows are retrieved in one batch.

See Also:

Statement.setFetchSize(int)

isFulltextEnabled

public boolean isFulltextEnabled()

Return true in case fulltext support is enabled in this configuration. If this is the case, the SPARQL module will prepare the database with appropriate fulltext index support. Since this adds additional overhead, it is not enabled by default.

Returns:

setFulltextEnabled

public KiWiConfiguration setFulltextEnabled(boolean fulltextEnabled)

Set to true in case fulltext support is enabled in this configuration. If this is the case, the SPARQL module will prepare the database with appropriate fulltext index support. Since this adds additional overhead, it is not enabled by default.

getFulltextLanguages

public String[] getFulltextLanguages()

Return the languages (ISO codes) for which to add specific fulltext search support. The SPARQL module will add a separate fulltext index for each supported language, adding additional overhead. In case you only want generic fulltext support, use the empty array.

setFulltextLanguages

public KiWiConfiguration setFulltextLanguages(String[] fulltextLanguages)

Set the languages (ISO codes) for which to add specific fulltext search support. The SPARQL module will add a separate fulltext index for each supported language, adding additional overhead. In case you only want generic fulltext support, use the empty array.

setFulltextLanguages

public KiWiConfiguration setFulltextLanguages(List<String> fulltextLanguages)

Set the languages (ISO codes) for which to add specific fulltext search support. The SPARQL module will add a separate fulltext index for each supported language, adding additional overhead. In case you only want generic fulltext support, use the empty array.

getCachingBackend

public CachingBackends getCachingBackend()

Fully qualified class name of the cache manager factory to use. Falls back to the Guava cache manager if not found

setCachingBackend

public KiWiConfiguration setCachingBackend(CachingBackends cachingBackend)

Fully qualified class name of the cache manager factory to use. Falls back to the Guava cache manager if not found

getNodeCacheSize

public int getNodeCacheSize()

The maximum size of the node ID cache used by the KiWiValueFactory (default: 1000000)

Returns:

setNodeCacheSize

public KiWiConfiguration setNodeCacheSize(int nodeCacheSize)

The maximum size of the node ID cache used by the KiWiValueFactory (default: 1000000)

getLiteralCacheSize

public int getLiteralCacheSize()

The maximum size of the literal cache used by the KiWiValueFactory (default: 100000)

Returns:

setLiteralCacheSize

public KiWiConfiguration setLiteralCacheSize(int literalCacheSize)

The maximum size of the literal cache used by the KiWiValueFactory (default: 100000)

getBNodeCacheSize

public int getBNodeCacheSize()

The maximum size of the BNode cache used by the KiWiValueFactory (default: 10000)

Returns:

setBNodeCacheSize

public KiWiConfiguration setBNodeCacheSize(int bNodeCacheSize)

The maximum size of the BNode cache used by the KiWiValueFactory (default: 10000)

getUriCacheSize

public int getUriCacheSize()

The maximum size of the URI cache used by the KiWiValueFactory (default: 500000)

Returns:

setUriCacheSize

public KiWiConfiguration setUriCacheSize(int uriCacheSize)

The maximum size of the URI cache used by the KiWiValueFactory (default: 500000)

getTripleCacheSize

public int getTripleCacheSize()

The maximum size of the triple cache used for looking up triples by id

Returns:

setTripleCacheSize

public KiWiConfiguration setTripleCacheSize(int tripleCacheSize)

The maximum size of the triple cache used for looking up triples by id

getNamespaceCacheSize

public int getNamespaceCacheSize()

The maximum size of the namespace cache used for looking up namespaces by prefix and uri

setNamespaceCacheSize

public KiWiConfiguration setNamespaceCacheSize(int namespaceCacheSize)

The maximum size of the namespace cache used for looking up namespaces by prefix and uri

getDatacenterId

public int getDatacenterId()

The datacenter ID of this server for generating unique database IDs. If not given, a random value will be generated.

Returns:

setDatacenterId

public KiWiConfiguration setDatacenterId(int datacenterId)

The datacenter ID of this server for generating unique database IDs.

Returns:

getRegistryStrategy

public RegistryStrategy getRegistryStrategy()

Return the strategy to use for synchronizing between transactions. Currently either "database" or "cache".

Returns:

setRegistryStrategy

public KiWiConfiguration setRegistryStrategy(RegistryStrategy registryStrategy)

Change the strategy to use for synchronizing between transactions. Currently either "database" or "cache".

Returns:

isClustered

public boolean isClustered()

If true, support for special cluster features is enabled (e.g. replicated caches).

Returns:

setClustered

public KiWiConfiguration setClustered(boolean clustered)

If true, support for special cluster features is enabled (e.g. replicated caches).

getCacheMode

public CacheMode getCacheMode()

Get the cache mode for this KiWi triple store. The following cluster modes are available:

• LOCAL: In local cache mode, the cache is not shared among the servers in a cluster. Each machine keeps a local cache. This allows quick startups and eliminates network traffic in the cluster, but subsequent requests to different cluster members cannot benefit from the cached data.
• DISTRIBUTED: In distributed cache mode, the cluster forms a big hash table used as a cache. This allows to make efficient use of the large amount of memory available, but requires cache rebalancing and a lot of network transfers, especially in case cluster members are restarted often.
• REPLICATED: In replicated cache mode, each node in the cluster has an identical copy of all cache data. This allows very efficient cache lookups and reduces the rebalancing effort, but requires more memory.

This setting is only relevant if clustered = true . If the configuration is not clustered, the triple store will always use LOCAL mode.

setCacheMode

public KiWiConfiguration setCacheMode(CacheMode cacheMode)

Set the cache mode for this KiWi triple store. The following cluster modes are available:

• LOCAL: In local cache mode, the cache is not shared among the servers in a cluster. Each machine keeps a local cache. This allows quick startups and eliminates network traffic in the cluster, but subsequent requests to different cluster members cannot benefit from the cached data.
• DISTRIBUTED: In distributed cache mode, the cluster forms a big hash table used as a cache. This allows to make efficient use of the large amount of memory available, but requires cache rebalancing and a lot of network transfers, especially in case cluster members are restarted often.
• REPLICATED: In replicated cache mode, each node in the cluster has an identical copy of all cache data. This allows very efficient cache lookups and reduces the rebalancing effort, but requires more memory.

This setting is only relevant if clustered = true . If the configuration is not clustered, the triple store will always use LOCAL mode.

Parameters:

cacheMode -

getClusterName

public String getClusterName()

Return the name of the cluster. This name is e.g. used by the Infinispan cache to identify other cache members in the same cluster,

Returns:

setClusterName

public KiWiConfiguration setClusterName(String clusterName)

Change the name of the cluster. This name is e.g. used by the Infinispan cache to identify other cache members in the same cluster,

getClusterPort

public int getClusterPort()

Return the multicast port used by the cache cluster this triplestore belongs to. This port number is used by JGroups to distribute and receive cache synchronization updates. Triplestores with different data should use different ports or addresses,

Only used in case isClustered() is true and the cache mode is not client-server.

Returns:

setClusterPort

public KiWiConfiguration setClusterPort(int clusterPort)

Change the multicast port used by the cache cluster this triplestore belongs to. This port number is used by JGroups to distribute and receive cache synchronization updates. Triplestores with different data should use different ports or addresses.

Only used in case isClustered() is true and the cache mode is not client-server.

Returns:

getClusterAddress

public String getClusterAddress()

The cluster address serves two purposes, depending on the kind of caching used.

• for distributed clusters (Infinispan, Hazelcast, ...), it specifies the multicast address used by the cache cluster this triplestore belongs to. This address is used by JGroups to distribute and receive cache synchronization updates. Triplestores with different data should use different ports or addresses,
• for client-server caches (Infinispan Remote, Memcached, ...), it specifies the list of cache servers to connect to.

Only used in case isClustered() is true

Returns:

setClusterAddress

public KiWiConfiguration setClusterAddress(String clusterAddress)

The cluster address serves two purposes, depending on the kind of caching used.

• for distributed clusters (Infinispan, Hazelcast, ...), it specifies the multicast address used by the cache cluster this triplestore belongs to. This address is used by JGroups to distribute and receive cache synchronization updates. Triplestores with different data should use different ports or addresses,
• for client-server caches (Infinispan Remote, Memcached, ...), it specifies the list of cache servers to connect to.

Only used in case isClustered() is true

Returns:

getClusterTimeout

public int getClusterTimeout()

setClusterTimeout

public void setClusterTimeout(int clusterTimeout)

isJmxEnabled

public boolean isJmxEnabled()

Return true if statistics collection in JMX. The JMX name of the KiWi statistics bean will be org.apache.marmotta.kiwi.jmx:type=KiWiStatisticsMBean

setJmxEnabled

public KiWiConfiguration setJmxEnabled(boolean jmxEnabled)

Enable/disable statistics collection in JMX. The JMX name of the KiWi statistics bean will be org.apache.marmotta.kiwi.jmx:type=KiWiStatisticsMBean

Parameters:

jmxEnabled -