Skip to content

Commit

Permalink
gchqgh-219 Code review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
m29827 committed Aug 10, 2021
1 parent 59bce39 commit d7da4ec
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ ${END_CODE}
Within the `AddGraph` operation, do not assign the "isPublic" parameter or assign it to false, this ensures the settings described in this section are not ignored.

#### Graph Auths
By assigning the parameter "graphAuths", all users that have one of the listed authorisations will have access to that graph. Note that "graphAuths" is mutually exclusive with the "readAccessPredicate" and "writeAccessPredicate" settings described in the [Access Controlled Resource](#access-controlled-resource) section.
By assigning the parameter "graphAuths", all users that have one of the listed authorisations will have access to that graph. Note that "graphAuths" is mutually exclusive with the "readAccessPredicate" setting described in the [Access Controlled Resource](#access-controlled-resource) section.

${START_JAVA_CODE}
${ADD_SECURE_GRAPH_SNIPPET}
Expand All @@ -218,7 +218,7 @@ ${END_CODE}
#### Access Controlled Resource
Graphs in the Federated Store implement the AccessControlledResource interface allowing configuration of a custom Predicate which is tested against the User to determine whether they can access the graph.
This example ensures readers of the graph have both the "read-access-auth-1" and "read-access-auth-2" auths and users attempting to remove the graph have both the "write-access-auth-1" and "write-access-auth-2" auths.
Note that the "readAccessPredicate" and "writeAccessPredicate" fields are mutually exclusive with the "graphAuths" setting described in the [Graph Auths](#graph-auths) section.
Note that the "readAccessPredicate" field is mutually exclusive with the "graphAuths" setting described in the [Graph Auths](#graph-auths) section.

${START_JAVA_CODE}
${ADD_ACCESS_CONTROLLED_RESOURCE_SECURE_GRAPH_SNIPPET}
Expand All @@ -230,7 +230,7 @@ ${END_CODE}

## Disallow Public Access
By default the `FederatedStore` will allow graphs to be added with public access.
However public access can be disallow by setting the property `gaffer.federatedstore.isPublicAllowed` to false.
Public access can be prevented by setting the property `gaffer.federatedstore.isPublicAllowed` to false.

${START_JAVA_CODE}
${DISALLOW_PUBLIC_ACCESS_SNIPPET}
Expand Down
7 changes: 3 additions & 4 deletions src/main/resources/dev/walkthrough/NamedOperations.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,10 +174,9 @@ ${ADD_NAMED_OPERATION_ACCESS_CONTROLLED_RESOURCE_SNIPPET}
${END_CODE}

## Full Example
The full example we saw in the the User Guide, where we extracted junctions heavily used by buses can also be written as a Named Operation.
To make it more useful, we have parameterised the vehicle type and the number of results to return.
We have also wrapped the ToCsv operation in an If operation so it can be
conditionally enabled/disabled.
The [complex example](../user-guide/full-example.md#example-complex-query) described in the User Guide where junctions heavily used by buses were extracted can also be written as a Named Operation.
To make it more useful vehicle type and the number of results to return have been parameterised.
We have also wrapped the ToCsv operation in an If operation so it can be conditionally enabled/disabled.

${START_JAVA_CODE}
${ADD_FULL_EXAMPLE_NAMED_OPERATION_SNIPPET}
Expand Down

0 comments on commit d7da4ec

Please sign in to comment.