EFLINT Server

A web server created to act as an API for https://ir.cwi.nl/pub/29922

To run

go to web-server directory

$ cd [project-home]/web-server

Compile

mvn compile

Run

mvn exec:java -Dexec.mainClass="eflint.Main"

Temporary settings

(ALL JUST FOR NOW)

src/main/java/eflint/InstanceManager.java :

    // limit of instances
    private int limit = 3;
    // eflint-server executable address
    private static final String EFLINT_COMMAND = "eflint-server"; // if on path
    // private static final String EFLINT_COMMAND = "/path/to/eflint-server"; // if not on path (recommended)

API Endpoints

create

endpoint: POST /create

description: creates an eflint instance and returns a unique uuid to it.

request:

{
	"template-name": "/absolute/path/to/pseudo-pesudo-gdpr.eflint",
	"values" : {
		"purposes": "Revenue + Research",
		"datatypes": "Address + Phone"
	},
    "flint-search-paths" : [
             "/path/to/included/flint/files"
         ]
}

the values can be empty values: {} or omitted if the template file is a pure eflint file (not a st4 template)

response:

{
    "status": "SUCCESS",
    "data": {
        "port": 31806,
        "uuid": "545a2d93-5e4d-4545-b91a-8f924850cafe",
        "source-file-name": "/absolute/path/to/pseudo-pesudo-gdpr.eflint",
        "flint-search-paths": [
             "/path/to/included/flint/files"
        ],
        "timestamp": "Jan 14, 2021, 11:21:29 AM"
    }
}

there is a limit to how many instances can be on the server and if exceeded the response will be

{
    "status": "ERROR",
    "message": "limit of 3 instances reached"
}

upload

endpoint: POST /upload

description: submit an eFLINT file under the name fileToUpload. behaves identical to a /create request with the uploaded file as template-name.

kill

endpoint: POST /kill

kills an instance of eflint provided the uuid

request :

{
    "uuid": "5bf5d826-85ee-45d1-a41a-d882fa272d5b",
    "request-type": "command",
    "data": {
        "command": "kill"
    }
}

response :

{
    "status": "SUCCESS",
    "message": "flint exited nicely :)"
}

kill_all

endpoint: POST /kill_all

kills all instances

request: none

response:

{
    "status": "SUCCESS"
}

get_all

GET /get_all

get a list of available efint instances as uuids

request: none

response:

{
    "status": "SUCCESS",
    "data": {
        "list": [
            {
                "port": 31806,
                "uuid": "545a2d93-5e4d-4545-b91a-8f924850cafe",
                "source-file-name": "/absolute/path/to/pseudo-pesudo-gdpr.eflint",
                "flint-search-paths": [
                     "/path/to/included/flint/files"
                ],
                "timestamp": "Jan 14, 2021, 11:21:29 AM"
            },
            {
               "port": 33206,
               "uuid": "545a2d93-5e4d-4545-b91a-8f924850cafe",
               "source-file-name": "/absolute/path/to/pseudo-pesudo-gdpr.eflint",
               "flint-search-paths": [
                    "/path/to/included/flint/files"
               ],
               "timestamp": "Jan 14, 2021, 11:21:29 AM"
            }
        ]
    }
}

command

POST /command

sends an EFLINT command to an instance of eflint and gets the response

example request:

{
	"uuid": "9b34343f-654a-454e-9a7d-2155f62586f3",
	"request-type": "command",
	"data": 
	{
		"command": "revert",
		"value": -1
	}
}

data is the main eflint request as described in its documentations

uuid is the instance intended for the request

example response:

{
    "status": "SUCCESS",
    "data": {
        "request": {
            "command": "revert",
            "value": -1
        },
        "response": {
            "violations": [],
            "response": "success",
            "new-state": 0
        }
    }
}