Package org.eclipse.rdf4j.sail.shacl
Class ShaclSailConnection
- java.lang.Object
-
- org.eclipse.rdf4j.sail.helpers.SailConnectionWrapper
-
- org.eclipse.rdf4j.sail.helpers.NotifyingSailConnectionWrapper
-
- org.eclipse.rdf4j.sail.shacl.ShaclSailConnection
-
- All Implemented Interfaces:
java.lang.AutoCloseable,FederatedServiceResolverClient,ThreadSafetyAware,NotifyingSailConnection,SailConnection,SailConnectionListener
public class ShaclSailConnection extends NotifyingSailConnectionWrapper implements SailConnectionListener
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classShaclSailConnection.SettingsclassShaclSailConnection.ValidationContainerDeprecated, for removal: This API element is subject to removal in a future version.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description ShaclSailConnection(ShaclSail sail, NotifyingSailConnection connection, SailRepositoryConnection shapesRepoConnection)ShaclSailConnection(ShaclSail sail, NotifyingSailConnection connection, SailRepositoryConnection shapesRepoConnection, SailConnection serializableConnection)ShaclSailConnection(ShaclSail sail, NotifyingSailConnection connection, SailConnection previousStateConnection, SailRepositoryConnection shapesRepoConnection)ShaclSailConnection(ShaclSail sail, NotifyingSailConnection connection, SailConnection previousStateConnection, SailRepositoryConnection shapesRepoConnection, SailConnection serializableConnection)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddConnectionListener(SailConnectionListener listener)Adds the given listener to the wrapped connection.voidaddStatement(Resource subj, IRI pred, Value obj, Resource... contexts)Adds a statement to the store.voidaddStatement(UpdateContext modify, Resource subj, IRI pred, Value obj, Resource... contexts)Adds a statement to the store.voidbegin()Begins a transaction requiringSailConnection.commit()orSailConnection.rollback()to be called to close the transaction.voidbegin(IsolationLevel level)Begins a transaction with the specifiedIsolationLevellevel, requiringSailConnection.commit()orSailConnection.rollback()to be called to close the transaction.private voidcheckIfShapesRefreshIsNeeded(Statement statement)private voidcheckTransactionalValidationLimit()private voidcleanup()private voidcleanupReadWriteLock()private voidcleanupShapesReadWriteLock()voidclear(Resource... contexts)Removes all statements from the specified/all contexts.voidclose()Closes the connection.voidcommit()Commits any updates that have been performed since the last timeSailConnection.commit()orSailConnection.rollback()was called.(package private) voidfillAddedAndRemovedStatementRepositories()(package private) ConnectionsGroupgetConnectionsGroup()private ShaclSailConnection.SettingsgetDefaultSettings(ShaclSail sail)private IsolationLevelgetIsolationLevel()private ShaclSailConnection.SettingsgetLocalTransactionSettings()private SailgetNewMemorySail()RdfsSubClassOfReasonergetRdfsSubClassOfReasoner()CloseableIteration<? extends Statement,SailException>getStatements(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts)Gets all statements from the specified contexts that have a specific subject, predicate and/or object.private longgetTimeStamp()(package private) ShaclSailConnection.SettingsgetTransactionSettings()booleanhasStatement(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts)Determines if the store contains any statements from the specified contexts that have a specific subject, predicate and/or object.private booleanisBulkValidation()private booleanisEmpty(java.util.List<ContextWithShape> shapesList)private booleanisParallelValidation()(package private) booleanisValidationEnabled()private ValidationReportperformValidation(java.util.List<ContextWithShape> shapes, boolean validateEntireBaseSail, ConnectionsGroup connectionsGroup)voidprepare()Checks for an error state in the active transaction that would force the transaction to be rolled back.(package private) voidprepareValidation(ValidationSettings validationSettings)voidremoveConnectionListener(SailConnectionListener listener)Removes the given listener from the wrapped connection.voidremoveStatement(UpdateContext modify, Resource subj, IRI pred, Value obj, Resource... contexts)Removes all statements matching the specified subject, predicate and object from the repository.voidremoveStatements(Resource subj, IRI pred, Value obj, Resource... contexts)Removes all statements matching the specified subject, predicate and object from the repository.ValidationReportrevalidate()voidrollback()Rolls back the transaction, discarding any uncommitted changes that have been made in this SailConnection.private ValidationReportserializableValidation(java.util.List<ContextWithShape> shapesAfterRefresh)voidsetTransactionSettings(TransactionSetting... settings)Pass any transaction-specific settings to the SailConnection.private booleanshouldUseSerializableValidation()voidstatementAdded(Statement statement)Notifies the listener that a statement has been added in a transaction that it has registered itself with.voidstatementRemoved(Statement statement)Notifies the listener that a statement has been removed in a transaction that it has registered itself with.private ValidationReportvalidate(java.util.List<ContextWithShape> shapes, boolean validateEntireBaseSail)-
Methods inherited from class org.eclipse.rdf4j.sail.helpers.NotifyingSailConnectionWrapper
getWrappedConnection
-
Methods inherited from class org.eclipse.rdf4j.sail.helpers.SailConnectionWrapper
clearNamespaces, endUpdate, evaluate, explain, flush, getContextIDs, getFederatedServiceResolver, getNamespace, getNamespaces, isActive, isOpen, pendingRemovals, prepareQuery, removeNamespace, setFederatedServiceResolver, setNamespace, size, size, startUpdate, supportsConcurrentReads
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.eclipse.rdf4j.sail.SailConnection
clearNamespaces, endUpdate, evaluate, explain, flush, getContextIDs, getNamespace, getNamespaces, isActive, isOpen, pendingRemovals, prepareQuery, removeNamespace, setNamespace, size, startUpdate
-
-
-
-
Field Detail
-
logger
private static final org.slf4j.Logger logger
-
previousStateConnection
private final SailConnection previousStateConnection
-
serializableConnection
private final SailConnection serializableConnection
-
useDefaultShapesGraph
private final boolean useDefaultShapesGraph
-
shapesGraphs
private IRI[] shapesGraphs
-
addedStatements
Sail addedStatements
-
removedStatements
Sail removedStatements
-
addedStatementsSet
private final java.util.HashSet<Statement> addedStatementsSet
-
removedStatementsSet
private final java.util.HashSet<Statement> removedStatementsSet
-
shapeRefreshNeeded
private boolean shapeRefreshNeeded
-
shapesModifiedInCurrentTransaction
private boolean shapesModifiedInCurrentTransaction
-
sail
public final ShaclSail sail
-
stats
private Stats stats
-
rdfsSubClassOfReasoner
RdfsSubClassOfReasoner rdfsSubClassOfReasoner
-
prepareHasBeenCalled
private boolean prepareHasBeenCalled
-
exclusiveSerializableValidationLock
private Lock exclusiveSerializableValidationLock
-
nonExclusiveSerializableValidationLock
private Lock nonExclusiveSerializableValidationLock
-
writableShapesCache
private StampedLockManager.Cache.WritableState writableShapesCache
-
readableShapesCache
private StampedLockManager.Cache.ReadableState readableShapesCache
-
shapesRepoConnection
private final SailRepositoryConnection shapesRepoConnection
-
connectionListenerActive
private boolean connectionListenerActive
-
currentIsolationLevel
private IsolationLevel currentIsolationLevel
-
transactionSettings
private ShaclSailConnection.Settings transactionSettings
-
transactionSettingsRaw
private TransactionSetting[] transactionSettingsRaw
-
closed
private volatile boolean closed
-
-
Constructor Detail
-
ShaclSailConnection
ShaclSailConnection(ShaclSail sail, NotifyingSailConnection connection, SailConnection previousStateConnection, SailRepositoryConnection shapesRepoConnection, SailConnection serializableConnection)
-
ShaclSailConnection
ShaclSailConnection(ShaclSail sail, NotifyingSailConnection connection, SailConnection previousStateConnection, SailRepositoryConnection shapesRepoConnection)
-
ShaclSailConnection
ShaclSailConnection(ShaclSail sail, NotifyingSailConnection connection, SailRepositoryConnection shapesRepoConnection, SailConnection serializableConnection)
-
ShaclSailConnection
ShaclSailConnection(ShaclSail sail, NotifyingSailConnection connection, SailRepositoryConnection shapesRepoConnection)
-
-
Method Detail
-
getDefaultSettings
private ShaclSailConnection.Settings getDefaultSettings(ShaclSail sail)
-
setTransactionSettings
public void setTransactionSettings(TransactionSetting... settings)
Description copied from interface:SailConnectionPass any transaction-specific settings to the SailConnection. This method needs to be called before the transaction isstarted.Sail implementations can override this method to receive the transaction settings (to inspect and/or pass them along to any wrapped sail objects). Remember to call
super.setTransactionSettings(settings)if you override this method.- Specified by:
setTransactionSettingsin interfaceSailConnection- Overrides:
setTransactionSettingsin classSailConnectionWrapper- Parameters:
settings- the transaction settings on which the next transaction operates. It may or may not contain the isolation level.
-
begin
public void begin() throws SailExceptionDescription copied from interface:SailConnectionBegins a transaction requiringSailConnection.commit()orSailConnection.rollback()to be called to close the transaction. The transaction will use the defaultIsolationLevellevel for the SAIL, as returned bySail.getDefaultIsolationLevel().- Specified by:
beginin interfaceSailConnection- Overrides:
beginin classSailConnectionWrapper- Throws:
SailException- If the connection could not start a transaction or if a transaction is already active on this connection.
-
begin
public void begin(IsolationLevel level) throws SailException
Description copied from interface:SailConnectionBegins a transaction with the specifiedIsolationLevellevel, requiringSailConnection.commit()orSailConnection.rollback()to be called to close the transaction.- Specified by:
beginin interfaceSailConnection- Overrides:
beginin classSailConnectionWrapper- Parameters:
level- the transaction isolation level on which this transaction operates.- Throws:
UnknownSailTransactionStateException- If the IsolationLevel is not supported by this implementationSailException- If the connection could not start a transaction, if the supplied transaction isolation level is not supported, or if a transaction is already active on this connection.
-
getLocalTransactionSettings
private ShaclSailConnection.Settings getLocalTransactionSettings()
- Returns:
- the transaction settings that are based purely on the settings based down through the begin(...) method without considering any sail level settings for things like caching or parallel validation.
-
addConnectionListener
public void addConnectionListener(SailConnectionListener listener)
Description copied from class:NotifyingSailConnectionWrapperAdds the given listener to the wrapped connection.- Specified by:
addConnectionListenerin interfaceNotifyingSailConnection- Overrides:
addConnectionListenerin classNotifyingSailConnectionWrapper- Parameters:
listener- A SailConnectionListener.
-
isValidationEnabled
boolean isValidationEnabled()
-
removeConnectionListener
public void removeConnectionListener(SailConnectionListener listener)
Description copied from class:NotifyingSailConnectionWrapperRemoves the given listener from the wrapped connection.- Specified by:
removeConnectionListenerin interfaceNotifyingSailConnection- Overrides:
removeConnectionListenerin classNotifyingSailConnectionWrapper- Parameters:
listener- A SailConnectionListener.
-
getNewMemorySail
private Sail getNewMemorySail()
-
commit
public void commit() throws SailExceptionDescription copied from interface:SailConnectionCommits any updates that have been performed since the last timeSailConnection.commit()orSailConnection.rollback()was called.- Specified by:
commitin interfaceSailConnection- Overrides:
commitin classSailConnectionWrapper- Throws:
UnknownSailTransactionStateException- If the transaction state can not be determined (this can happen for instance when communication between client and server fails or times-out). It does not indicate a problem with the integrity of the store.SailException- If the SailConnection could not be committed.
-
addStatement
public void addStatement(UpdateContext modify, Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException
Description copied from interface:SailConnectionAdds a statement to the store. Called when adding statements through aUpdateExproperation.- Specified by:
addStatementin interfaceSailConnection- Overrides:
addStatementin classSailConnectionWrapper- Parameters:
modify- operation properties of theUpdateExproperation producing these statements.subj- The subject of the statement to add.pred- The predicate of the statement to add.obj- The object of the statement to add.contexts- The context(s) to add the statement to. Note that this parameter is a vararg and as such is optional. If no contexts are specified, a context-less statement will be added.- Throws:
SailException- If the statement could not be added, for example because no transaction is active.
-
removeStatement
public void removeStatement(UpdateContext modify, Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException
Description copied from interface:SailConnectionRemoves all statements matching the specified subject, predicate and object from the repository. All three parameters may be null to indicate wildcards. Called when removing statements through aUpdateExproperation.- Specified by:
removeStatementin interfaceSailConnection- Overrides:
removeStatementin classSailConnectionWrapper- Parameters:
modify- operation properties of theUpdateExproperation removing these statements.subj- The subject of the statement that should be removed.pred- The predicate of the statement that should be removed.obj- The object of the statement that should be removed.contexts- The context(s) from which to remove the statement. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Throws:
SailException- If the statement could not be removed, for example because no transaction is active.
-
addStatement
public void addStatement(Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException
Description copied from interface:SailConnectionAdds a statement to the store.- Specified by:
addStatementin interfaceSailConnection- Overrides:
addStatementin classSailConnectionWrapper- Parameters:
subj- The subject of the statement to add.pred- The predicate of the statement to add.obj- The object of the statement to add.contexts- The context(s) to add the statement to. Note that this parameter is a vararg and as such is optional. If no contexts are specified, a context-less statement will be added.- Throws:
SailException- If the statement could not be added, for example because no transaction is active.
-
removeStatements
public void removeStatements(Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException
Description copied from interface:SailConnectionRemoves all statements matching the specified subject, predicate and object from the repository. All three parameters may be null to indicate wildcards.- Specified by:
removeStatementsin interfaceSailConnection- Overrides:
removeStatementsin classSailConnectionWrapper- Parameters:
subj- The subject of the statement that should be removed, or null to indicate a wildcard.pred- The predicate of the statement that should be removed, or null to indicate a wildcard.obj- The object of the statement that should be removed , or null to indicate a wildcard. *contexts- The context(s) from which to remove the statement. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Throws:
SailException- If the statement could not be removed, for example because no transaction is active.
-
clear
public void clear(Resource... contexts) throws SailException
Description copied from interface:SailConnectionRemoves all statements from the specified/all contexts. If no contexts are specified the method operates on the entire repository.- Specified by:
clearin interfaceSailConnection- Overrides:
clearin classSailConnectionWrapper- Parameters:
contexts- The context(s) from which to remove the statements. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Throws:
SailException- If the statements could not be removed.
-
rollback
public void rollback() throws SailExceptionDescription copied from interface:SailConnectionRolls back the transaction, discarding any uncommitted changes that have been made in this SailConnection.- Specified by:
rollbackin interfaceSailConnection- Overrides:
rollbackin classSailConnectionWrapper- Throws:
UnknownSailTransactionStateException- If the transaction state can not be determined (this can happen for instance when communication between client and server fails or times-out). It does not indicate a problem with the integrity of the store.SailException- If the SailConnection could not be rolled back.
-
cleanup
private void cleanup()
-
cleanupShapesReadWriteLock
private void cleanupShapesReadWriteLock()
-
cleanupReadWriteLock
private void cleanupReadWriteLock()
-
validate
private ValidationReport validate(java.util.List<ContextWithShape> shapes, boolean validateEntireBaseSail) throws java.lang.InterruptedException
- Throws:
java.lang.InterruptedException
-
prepareValidation
void prepareValidation(ValidationSettings validationSettings) throws java.lang.InterruptedException
- Throws:
java.lang.InterruptedException
-
getConnectionsGroup
ConnectionsGroup getConnectionsGroup()
-
performValidation
private ValidationReport performValidation(java.util.List<ContextWithShape> shapes, boolean validateEntireBaseSail, ConnectionsGroup connectionsGroup) throws java.lang.InterruptedException
- Throws:
java.lang.InterruptedException
-
isParallelValidation
private boolean isParallelValidation()
-
fillAddedAndRemovedStatementRepositories
void fillAddedAndRemovedStatementRepositories() throws java.lang.InterruptedException- Throws:
java.lang.InterruptedException
-
getIsolationLevel
private IsolationLevel getIsolationLevel()
-
close
public void close() throws SailExceptionDescription copied from interface:SailConnectionCloses the connection. Any updates that haven't been committed yet will be rolled back. The connection can no longer be used once it is closed.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfaceSailConnection- Overrides:
closein classSailConnectionWrapper- Throws:
SailException
-
prepare
public void prepare() throws SailExceptionDescription copied from interface:SailConnectionChecks for an error state in the active transaction that would force the transaction to be rolled back. This is an optional call; calling or not calling this method should have no effect on the outcome ofSailConnection.commit()orSailConnection.rollback(). A call to this method must be followed by (in the same thread) with a call toSailConnection.prepare(),SailConnection.commit(),SailConnection.rollback(), orSailConnection.close(). This method may be called multiple times within the same transaction by the same thread. If this method returns normally, the caller can reasonably expect that a subsequent call toSailConnection.commit()will also return normally. If this method returns with an exception the caller should treat the exception as if it came from a call toSailConnection.commit().- Specified by:
preparein interfaceSailConnection- Overrides:
preparein classSailConnectionWrapper- Throws:
UnknownSailTransactionStateException- If the transaction state can not be determined (this can happen for instance when communication between client and server fails or times-out). It does not indicate a problem with the integrity of the store.SailException- If there is an active transaction and it cannot be committed.
-
isEmpty
private boolean isEmpty(java.util.List<ContextWithShape> shapesList)
-
shouldUseSerializableValidation
private boolean shouldUseSerializableValidation()
-
isBulkValidation
private boolean isBulkValidation()
-
serializableValidation
private ValidationReport serializableValidation(java.util.List<ContextWithShape> shapesAfterRefresh) throws java.lang.InterruptedException
- Throws:
java.lang.InterruptedException
-
statementAdded
public void statementAdded(Statement statement)
Description copied from interface:SailConnectionListenerNotifies the listener that a statement has been added in a transaction that it has registered itself with.- Specified by:
statementAddedin interfaceSailConnectionListener- Parameters:
statement- The statement that was added.
-
statementRemoved
public void statementRemoved(Statement statement)
Description copied from interface:SailConnectionListenerNotifies the listener that a statement has been removed in a transaction that it has registered itself with.- Specified by:
statementRemovedin interfaceSailConnectionListener- Parameters:
statement- The statement that was removed.
-
checkIfShapesRefreshIsNeeded
private void checkIfShapesRefreshIsNeeded(Statement statement)
-
checkTransactionalValidationLimit
private void checkTransactionalValidationLimit()
-
getRdfsSubClassOfReasoner
public RdfsSubClassOfReasoner getRdfsSubClassOfReasoner()
-
getStatements
public CloseableIteration<? extends Statement,SailException> getStatements(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException
Description copied from interface:SailConnectionGets all statements from the specified contexts that have a specific subject, predicate and/or object. All three parameters may be null to indicate wildcards. The includeInferred parameter can be used to control which statements are fetched: all statements or only the statements that have been added explicitly.- Specified by:
getStatementsin interfaceSailConnection- Overrides:
getStatementsin classSailConnectionWrapper- Parameters:
subj- A Resource specifying the subject, or null for a wildcard.pred- A URI specifying the predicate, or null for a wildcard.obj- A Value specifying the object, or null for a wildcard.includeInferred- if false, no inferred statements are returned; if true, inferred statements are returned if availablecontexts- The context(s) to get the data from. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Returns:
- The statements matching the specified pattern.
- Throws:
SailException- If the Sail object encountered an error or unexpected situation internally.
-
hasStatement
public boolean hasStatement(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException
Description copied from interface:SailConnectionDetermines if the store contains any statements from the specified contexts that have a specific subject, predicate and/or object. All three parameters may be null to indicate wildcards. The includeInferred parameter can be used to control which statements are checked: all statements or only the statements that have been added explicitly.- Specified by:
hasStatementin interfaceSailConnection- Overrides:
hasStatementin classSailConnectionWrapper- Parameters:
subj- A Resource specifying the subject, or null for a wildcard.pred- An IRI specifying the predicate, or null for a wildcard.obj- A Value specifying the object, or null for a wildcard.includeInferred- if false, no inferred statements are returned; if true, inferred statements are returned if availablecontexts- The context(s) to get the data from. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Returns:
trueiff the store contains any statements matching the supplied criteria,falseotherwise.- Throws:
SailException- If the Sail object encountered an error or unexpected situation internally.
-
revalidate
public ValidationReport revalidate()
-
getTransactionSettings
ShaclSailConnection.Settings getTransactionSettings()
-
getTimeStamp
private long getTimeStamp()
-
-