{"id":29840603,"url":"https://github.com/graphform/swim-flink-connector","last_synced_at":"2025-07-29T14:17:24.377Z","repository":{"id":197714063,"uuid":"648311566","full_name":"graphform/swim-flink-connector","owner":"graphform","description":null,"archived":false,"fork":false,"pushed_at":"2023-10-04T13:15:15.000Z","size":78,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-06-23T03:54:31.340Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/graphform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-01T17:16:54.000Z","updated_at":"2025-06-20T22:21:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"86bbc0b3-7acb-4946-9de0-53e890468a85","html_url":"https://github.com/graphform/swim-flink-connector","commit_stats":null,"previous_names":["swimos/swim-flink-connector","graphform/swim-flink-connector"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/graphform/swim-flink-connector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-flink-connector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-flink-connector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-flink-connector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-flink-connector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/graphform","download_url":"https://codeload.github.com/graphform/swim-flink-connector/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-flink-connector/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267701688,"owners_count":24130458,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-29T14:16:48.339Z","updated_at":"2025-07-29T14:17:24.371Z","avatar_url":"https://github.com/graphform.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003ca href=\"https://www.swimos.org\"\u003e\u003cimg src=\"https://docs.swimos.org/readme/breach-marlin-blue-wide.svg\"\u003e\u003c/a\u003e Swim Flink Connector Library\u0026ensp;![version](https://img.shields.io/github/tag/swimos/swim.svg?label=version) [![license](https://img.shields.io/github/license/swimos/swim.svg?color=blue)](https://github.com/swimos/swim/blob/main/LICENSE)\n\n\nThis is a [Flink Connector](https://nightlies.apache.org/flink/flink-docs-master/docs/connectors/datastream/overview/) library. The Swim Flink Connector library\nacts as a bridge between Flink and Swim applications. This library should be configured to send messages generated from\nFlink jobs to a specified Swim application.\n\n\n## Apache Flink\n\nApache Flink is an open source stream processing framework with powerful stream- and batch-processing capabilities.\n\nLearn more about Flink at [https://flink.apache.org/](https://flink.apache.org/)\n\n\n## Building the Swim Flink Connector from Source\n\n### Prerequisites\n\n- Install JDK 11\n- Ensure that your `JAVA_HOME` environment variable points to the Java installation.\n- Ensure that your `PATH` includes `$JAVA_HOME`.\n\n### On Windows\n\n```bat\n$ .\\gradlew.bat build\n```\n\n### On Linux or MacOS\n\n```bash\n$ ./gradlew build\n```\n\nThe resulting jars can be found in the `build/libs`.\n\n\n## Design and Implementation Details\n\n### Swim Application Overview\nSwim applications consist of interconnected, distributed objects, called Web Agents. Each Web Agent has URI address, like a REST endpoint.\nBut unlike RESTful Web Services, Web Agents are stateful, and accessed via streaming APIs.  Each Web Agent has a set of named lanes,\nrepresenting the properties and methods of the Web Agent. Lanes come in several varieties, corresponding to common data structures and access patterns.\n\nTo send a message to a specific Web Agent, external systems (like the Swim Flink Connector) need the following:\n1. Host URI : A Swim Application has a Host URI (similar to a web server's host URI).\n2. Web Agent URI: Web Agents are hosted in a Swim Application and have unique URIs (similar to a REST endpoint).\n3. Lane URI: The name of the lane in the Web Agent.\n\nFor a detailed overview of Swim concepts please refer to [swimos.org](https://www.swimos.org/concepts/)\n\n\n## Validating with the Test Application and Example Job\nThe Swim Flink Connector library can be validated by running the test application ([test-app](test-app)) alongside the\n([example-job](example-job)).\nSee the [test-app](test-app/README.md) and [example-job](example-job/README.md) documentation to view how to run each respectively.\n\n### Access the data from the Application\nData sent to the Web Agents in the Test Application from the Swim Flink Connector library can be accessed using HTTP APIs.\nFor example, if the `id` extracted from the message is \"User_5\" then the Swim Flink Connector Library will compute the agent URI to\nbe: `/agent/User_5`. The HTTP API to get the message from this agent will be  \n`http://\u003chost-name\u003e:9001/agent/User_5?lane=latestData`\n\nIf the `id` extracted from the message is \"User_7\", then the HTTP API to get the message from this agent will be:  \n`http://\u003chost-name\u003e:9001/agent/User_7?lane=latestData`\n\nHere the `\u003chost-name\u003e` will be \"localhost\" if the Test Application is running on the same machine as the Swim Flink Connector library.\nIf the Test Application is running on a different machine then the `\u003chost-name\u003e` will be the Fully Qualified Domain Name of the machine.\n\n\n## Repository Structure\n\n### Key files\n\n- [gradlew](gradlew)/[gradlew.bat](gradlew.bat) — gradle wrapper\n- [build.gradle](build.gradle) — gradle file to build the library\n- [gradle.properties](gradle.properties) — configuration variables\n\n### Key directories\n\n- [src](src) — source code\n    - [main/java](src/main/java) — java source code\n    - [main/resources](src/main/resources) — configuration files\n    - [test](src/test)-unit test code\n- [test-app](test-app) — test Swim application which may be used to validate the swim-flink-connector library\n- [example-job](example-job) — example Flink job which may be used to validate the swim-flink-connector library","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphform%2Fswim-flink-connector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraphform%2Fswim-flink-connector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphform%2Fswim-flink-connector/lists"}