gh-2630 FederatedStore scripts added.

example/federated-demo/basic/scripts/addMapEdgesClashingGraph.sh

@@ -36,7 +36,6 @@ curl -X POST --header 'Content-Type: application/json' --header 'Accept: applica
              }
            ]
          }
-       }
      }
     },
     "isPublic": true

example/real-federated-store/README.md

@@ -12,11 +12,11 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 
-Real FederatedStore Demo
+Real FederatedStore Example
 =============
 
 ## Deployment
-This demo does not start or configure a real accumulo cluster. Without you having access to an Accumulo cluster you will not be able to use a Gaffer Accumulo Store.
+This example does not start or configure a real accumulo cluster. Without you having access to an Accumulo cluster you will not be able to use a Gaffer Accumulo Store.
 
 Assuming you have Java 8, Maven and Git installed, you can build and run the latest version of Gaffer FederatedStore locally by doing the following:
 ```bash
@@ -30,3 +30,7 @@ cd Gaffer/example/real-federated-store/
 ```
 
 The rest api will be deployed to localhost:8080/rest.
+
+
+## Example Operations
+Examples can be found at `have-a-go-at-operations`.

example/real-federated-store/have-a-go-at-operations/README.md

@@ -0,0 +1,32 @@
+Copyright 2022-2022 Crown Copyright
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Have A Go Operations
+=============
+
+Your FederatedStore  will be empty the first time, so a graph followed by elements will need to be added. Example operations can be found here.
+
+## JSON
+Example json operations can be found at `json-operation-examples`. 
+Copy & paste the files contents into the Swaggers execute panel.
+
+## Curl Command
+Example curl commands within shell scripts can be found at `curl-opertion-examples`. Execute these shell scripts or copy past the curl command into your terminal.
+
+```bash
+cd curl-operation-examples/
+./curl_getAllGraphIds.sh
+```
+
+The rest api will be deployed to localhost:8080/rest.

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_add1BasicEdge.sh

@@ -0,0 +1 @@
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d @../json-operation-examples/operation_add1BasicEdge.json 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_add1BasicEdge_alternative.sh

@@ -0,0 +1,16 @@
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
+    "class" : "uk.gov.gchq.gaffer.operation.impl.add.AddElements",
+    "input" : [ {
+     "group" : "BasicEdge",
+     "source" : "1",
+     "destination" : "2",
+     "directed" : true,
+     "properties" : {
+       "count" : 1
+     },
+     "class" : "uk.gov.gchq.gaffer.data.element.Edge"
+    } ],
+     "options": {
+      "gaffer.federatedstore.operation.graphIds": "mapEdges"
+      }
+ }' 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_addGraphForBasicEdges.sh

@@ -0,0 +1 @@
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d @../json-operation-examples/operation_addGraphForBasicEdges.json 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_addGraphForBasicEdges_alternative.sh

@@ -0,0 +1,41 @@
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
+    "class": "AddGraph",
+    "graphId": "mapEdges",
+    "storeProperties": {
+      "gaffer.store.class":"uk.gov.gchq.gaffer.mapstore.MapStore"
+    },
+    "schema": {
+         "edges": {
+             "BasicEdge": {
+               "source": "vertex",
+               "destination": "vertex",
+               "directed": "true",
+               "properties": {
+                 "count": "count"
+               }
+             }
+           },
+
+       "types": {
+         "vertex": {
+           "class": "java.lang.String"
+         },
+         "count": {
+           "class": "java.lang.Integer",
+           "aggregateFunction": {
+             "class": "uk.gov.gchq.koryphe.impl.binaryoperator.Sum"
+           }
+         },
+         "true": {
+           "description": "A simple boolean that must always be true.",
+           "class": "java.lang.Boolean",
+           "validateFunctions": [
+             {
+               "class": "uk.gov.gchq.koryphe.impl.predicate.IsTrue"
+             }
+           ]
+         }
+       }
+    },
+    "isPublic": true
+ }' 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_getAllElements.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d @../json-operation-examples/operation_getAllElements.json 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_getAllGraphIds.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d @../json-operation-examples/operation_getAllGraphIds.json 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_getSchema.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d @../json-operation-examples/operation_getSchema.json 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_getSchema_alternative.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '
+{
+"class":"getSchema"
+}' 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_removeBasicEdgeGraph.sh

@@ -0,0 +1 @@
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d @../json-operation-examples/operation_removeBasicEdgeGraph.json 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/curl-operation-examples/curl_removeBasicEdgeGraph_alternative.sh

@@ -0,0 +1,4 @@
+curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
+"class": "removeGraph",
+"graphId": "mapEdges"
+}' 'http://localhost:8080/rest/graph/operations/execute'

example/real-federated-store/have-a-go-at-operations/json-operation-examples/operation_add1BasicEdge.json

@@ -0,0 +1,18 @@
+{
+  "class": "uk.gov.gchq.gaffer.operation.impl.add.AddElements",
+  "input": [
+    {
+      "group": "BasicEdge",
+      "source": "1",
+      "destination": "2",
+      "directed": true,
+      "properties": {
+        "count": 1
+      },
+      "class": "uk.gov.gchq.gaffer.data.element.Edge"
+    }
+  ],
+  "options": {
+    "gaffer.federatedstore.operation.graphIds": "mapEdges"
+  }
+}

example/real-federated-store/have-a-go-at-operations/json-operation-examples/operation_addGraphForBasicEdges.json

@@ -0,0 +1,40 @@
+{
+  "class": "AddGraph",
+  "graphId": "mapEdges",
+  "storeProperties": {
+    "gaffer.store.class": "uk.gov.gchq.gaffer.mapstore.MapStore"
+  },
+  "schema": {
+    "edges": {
+      "BasicEdge": {
+        "source": "vertex",
+        "destination": "vertex",
+        "directed": "true",
+        "properties": {
+          "count": "count"
+        }
+      }
+    },
+    "types": {
+      "vertex": {
+        "class": "java.lang.String"
+      },
+      "count": {
+        "class": "java.lang.Integer",
+        "aggregateFunction": {
+          "class": "uk.gov.gchq.koryphe.impl.binaryoperator.Sum"
+        }
+      },
+      "true": {
+        "description": "A simple boolean that must always be true.",
+        "class": "java.lang.Boolean",
+        "validateFunctions": [
+          {
+            "class": "uk.gov.gchq.koryphe.impl.predicate.IsTrue"
+          }
+        ]
+      }
+    }
+  },
+  "isPublic": true
+}

example/real-federated-store/have-a-go-at-operations/json-operation-examples/operation_getAllElements.json

@@ -0,0 +1,3 @@
+{
+  "class": "GetAllElements"
+}

example/real-federated-store/have-a-go-at-operations/json-operation-examples/operation_getAllGraphIds.json

@@ -0,0 +1,3 @@
+{
+  "class": "GetAllGraphIds"
+}

example/real-federated-store/have-a-go-at-operations/json-operation-examples/operation_getSchema.json

@@ -0,0 +1,3 @@
+{
+  "class": "GetSchema"
+}

example/real-federated-store/have-a-go-at-operations/json-operation-examples/operation_removeBasicEdgeGraph.json

@@ -0,0 +1,4 @@
+{
+  "class": "removeGraph",
+  "graphId": "mapEdges"
+}