graph-guard/io.github.cfraser.graphguard/Server

Server

class Server @JvmOverloads constructor(val graph: URI, plugin: Server.Plugin = Plugin.DSL.plugin {}, val address: InetSocketAddress = InetSocketAddress("localhost", 8787), parallelism: Int? = null) : Runnable

Server proxies Bolt data to a Neo4j (5+ compatible) database and performs dynamic message transformation through the plugin.

Parameters

plugin

the Server.Plugin to use to intercept proxied messages and observe server events

Constructors

constructor(graph: URI, plugin: Server.Plugin = Plugin.DSL.plugin {}, address: InetSocketAddress = InetSocketAddress("localhost", 8787), parallelism: Int? = null)

Types

data class Connected(val connection: Server.Connection) : Record, Server.Event

The Server established a connection.

sealed interface Connection

A proxy connection.

data class Disconnected(val connection: Server.Connection) : Record, Server.Event

The Server closed the connection.

sealed interface Event

A Server event.

interface Plugin

Server.Plugin enables Server functionality to be augmented and/or observed.

data class Proxied(val session: Bolt.Session, val source: Server.Connection, val received: Bolt.Message, val destination: Server.Connection, val sent: Bolt.Message) : Record, Server.Event

The Server proxied the intercepted Bolt.Message from the source to the destination.

data object Started : Server.Event

The Server has started.

data object Stopped : Server.Event

The Server has stopped.

Properties

val address: InetSocketAddress

the InetSocketAddress to bind the Server to

the URI of the graph database to proxy data to/from

Functions

open override fun run()

Start the proxy server on the address, connecting to the graph.