org.neo4j.kernel.impl.newapi.DefaultRelationshipValueIndexCursor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation
Show all versions of neo4j-kernel Show documentation
Neo4j kernel is a lightweight, embedded Java database designed to
store data structured as graphs rather than tables. For more
information, see http://neo4j.org.
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [https://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see
implements RelationshipValueIndexCursor {
private final InternalCursorFactory internalCursors;
private final DefaultRelationshipScanCursor relationshipScanCursor;
private final boolean applyAccessModeToTxState;
private DefaultPropertyCursor securityPropertyCursor;
private int[] propertyIds;
DefaultRelationshipValueIndexCursor(
CursorPool pool,
DefaultRelationshipScanCursor relationshipScanCursor,
InternalCursorFactory internalCursors,
boolean applyAccessModeToTxState) {
super(pool, applyAccessModeToTxState);
this.relationshipScanCursor = relationshipScanCursor;
this.internalCursors = internalCursors;
this.applyAccessModeToTxState = applyAccessModeToTxState;
}
@Override
public void source(NodeCursor cursor) {
checkReadFromStore();
read.singleNode(relationshipScanCursor.sourceNodeReference(), cursor);
}
@Override
public void target(NodeCursor cursor) {
checkReadFromStore();
read.singleNode(relationshipScanCursor.targetNodeReference(), cursor);
}
@Override
public int type() {
checkReadFromStore();
return relationshipScanCursor.type();
}
@Override
public long relationshipReference() {
return entityReference();
}
@Override
public long sourceNodeReference() {
checkReadFromStore();
return relationshipScanCursor.sourceNodeReference();
}
@Override
public long targetNodeReference() {
checkReadFromStore();
return relationshipScanCursor.targetNodeReference();
}
@Override
public void properties(PropertyCursor cursor, PropertySelection selection) {
checkReadFromStore();
relationshipScanCursor.properties(cursor, selection);
}
@Override
public Reference propertiesReference() {
checkReadFromStore();
return relationshipScanCursor.propertiesReference();
}
@Override
public boolean readFromStore() {
if (relationshipScanCursor.relationshipReference() == entity) {
// A security check, or a previous call to this method for this relationship already seems to have loaded
// this relationship
return true;
}
relationshipScanCursor.single(entity, read);
return relationshipScanCursor.next();
}
private void checkReadFromStore() {
if (relationshipScanCursor.relationshipReference() != entity) {
throw new IllegalStateException("Relationship hasn't been read from store");
}
}
@Override
protected boolean doStoreValuePassesQueryFilter(
long reference, PropertySelection propertySelection, PropertyIndexQuery[] query) {
read.singleRelationship(reference, relationshipScanCursor);
if (relationshipScanCursor.next()) {
if (securityPropertyCursor == null) {
securityPropertyCursor = internalCursors.allocatePropertyCursor();
}
relationshipScanCursor.properties(securityPropertyCursor, propertySelection);
return CursorPredicates.propertiesMatch(securityPropertyCursor, query);
}
return false;
}
/**
* Check that the user is allowed to access all relationships and properties given by the index descriptor.
*
* We can skip checking permissions on every relationship we get back if the current user is allowed to:
*
* - traverse all relationships of type the index is defined for
* - traverse all nodes no matter what label the node has
* - read all the indexed properties
*
*/
@Override
protected boolean canAccessAllDescribedEntities(IndexDescriptor descriptor) {
propertyIds = descriptor.schema().getPropertyIds();
AccessMode accessMode = read.getAccessMode();
for (int relType : descriptor.schema().getEntityTokenIds()) {
if (!accessMode.allowsTraverseRelType(relType)) {
return false;
}
}
if (!accessMode.allowsTraverseAllLabels()) {
return false;
}
for (int propId : propertyIds) {
for (int relType : descriptor.schema().getEntityTokenIds()) {
if (!accessMode.allowsReadRelationshipProperty(() -> relType, propId)) {
return false;
}
}
}
return true;
}
@Override
protected LongSet removed(TransactionState txState, LongSet removedFromIndex) {
return mergeToSet(txState.addedAndRemovedRelationships().getRemoved(), removedFromIndex)
.asUnmodifiable();
}
@Override
protected final boolean canAccessEntityAndProperties(long reference) {
readEntity(read -> read.singleRelationship(reference, relationshipScanCursor));
if (!relationshipScanCursor.next()) {
// This relationship is not visible to this security context
return false;
}
int relType = relationshipScanCursor.type();
for (int prop : propertyIds) {
if (!read.getAccessMode().allowsReadRelationshipProperty(() -> relType, prop)) {
return false;
}
}
return true;
}
@Override
void traceOnEntity(KernelReadTracer tracer, long entity) {
tracer.onRelationship(entity);
}
@Override
String implementationName() {
return "RelationshipValueIndexCursor";
}
@Override
public void release() {
if (relationshipScanCursor != null) {
relationshipScanCursor.close();
relationshipScanCursor.release();
}
if (securityPropertyCursor != null) {
securityPropertyCursor.close();
securityPropertyCursor.release();
securityPropertyCursor = null;
}
}
}