{"id":21664829,"url":"https://github.com/th2-net/th2-conn-ws-client","last_synced_at":"2026-04-18T11:32:29.524Z","repository":{"id":40268406,"uuid":"337410707","full_name":"th2-net/th2-conn-ws-client","owner":"th2-net","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-03T08:45:00.000Z","size":109,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-24T11:02:00.268Z","etag":null,"topics":["th2-conn","websocket"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/th2-net.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-02-09T13:19:15.000Z","updated_at":"2022-08-30T07:51:20.000Z","dependencies_parsed_at":"2023-02-10T04:30:25.331Z","dependency_job_id":"3d00ab9d-046e-4721-9c76-c7ed93a36d74","html_url":"https://github.com/th2-net/th2-conn-ws-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/th2-net/th2-conn-ws-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/th2-net%2Fth2-conn-ws-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/th2-net%2Fth2-conn-ws-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/th2-net%2Fth2-conn-ws-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/th2-net%2Fth2-conn-ws-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/th2-net","download_url":"https://codeload.github.com/th2-net/th2-conn-ws-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/th2-net%2Fth2-conn-ws-client/sbom","scorecard":{"id":876277,"data":{"date":"2025-08-11","repo":{"name":"github.com/th2-net/th2-conn-ws-client","commit":"106d4edb5f7f59880294d6de03e7d8b620186bee"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":4,"reason":"Found 8/17 approved changesets -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci-unwelcome-words.yml:1","Warn: no topLevel permission defined: .github/workflows/dev-docker-publish.yml:1","Warn: no topLevel permission defined: .github/workflows/dev-java-publish-sonatype.yml:1","Warn: no topLevel permission defined: .github/workflows/docker-publish.yml:1","Warn: no topLevel permission defined: .github/workflows/java-publish-sonatype.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-unwelcome-words.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/ci-unwelcome-words.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-unwelcome-words.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/ci-unwelcome-words.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dev-docker-publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/dev-docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dev-docker-publish.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/dev-docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dev-docker-publish.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/dev-docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dev-docker-publish.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/dev-docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dev-docker-publish.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/dev-docker-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dev-java-publish-sonatype.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/dev-java-publish-sonatype.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dev-java-publish-sonatype.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/dev-java-publish-sonatype.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dev-java-publish-sonatype.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/dev-java-publish-sonatype.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dev-java-publish-sonatype.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/dev-java-publish-sonatype.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/docker-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker-publish.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/docker-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/java-publish-sonatype.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/java-publish-sonatype.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/java-publish-sonatype.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/th2-net/th2-conn-ws-client/java-publish-sonatype.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1","Warn: containerImage not pinned by hash: Dockerfile:6: pin your Docker image by updating adoptopenjdk/openjdk11:alpine to adoptopenjdk/openjdk11:alpine@sha256:dd0098ad254fbb8b943593cce8caec8fc767496a81398b685dd1182a70901325","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  10 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'","Warn: branch protection not enabled for branch 'dev-version-1'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-24T06:07:32.172Z","repository_id":40268406,"created_at":"2025-08-24T06:07:32.172Z","updated_at":"2025-08-24T06:07:32.172Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31966968,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"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":["th2-conn","websocket"],"created_at":"2024-11-25T10:43:49.183Z","updated_at":"2026-04-18T11:32:29.490Z","avatar_url":"https://github.com/th2-net.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebSocket Client v0.3.1\n\nThis microservice allows sending and receiving messages via WebSocket protocol\n\n## Configuration\n\nThe main configuration is done by changing following properties:\n\n+ **uri** - connection URI\n+ **frameType** - outgoing WebSocket frame type, can be either `TEXT` or `BINARY` (`TEXT` by default)\n+ **sessionAlias** - session alias for incoming/outgoing th2 messages (e.g. `ws_api`)\n+ **handlerSettings** - WebSocket event handler settings\n+ **grpcStartControl** - enables start/stop control via [gRPC service](https://github.com/th2-net/th2-grpc-conn/blob/master/src/main/proto/th2_grpc_conn/conn.proto#L24) (`false` by default)\n+ **autoStart** - start service automatically (`true` by default and if `startControl` is `false`)\n+ **autoStopAfter** - stop after N seconds if the service was started automatically prior to send (`0` by default which means disabled)\n\nService will also automatically connect prior to message send if it wasn't connected\n\n### Event handler configuration\n\nEvent handler can be configured by changing following properties in the `handlerSettings` block of the main configuration:\n\n+ **pingInterval** - interval for sending ping-messages in ms (`30000` by default)\n+ **defaultHeaders** - map of headers and their values to add to the HTTP handshake request (the map is **empty** by default)\n\n### Configuration example\n\n```yaml\nuri: wss://echo.websocket.org\nframeType: TEXT\nsessionAlias: api_session\nstartControl: true\nautoStart: true\nhandlerSettings:\n  pingInterval: 30000\n  defaultHeaders:\n    HeaderA:\n      - value1\n      - value2\n    HeaderB:\n      - value3\n```\n\n### MQ pins\n\n* input queue with `subscribe` and `send` attributes for outgoing messages\n* output queue with `publish`, `first` (for incoming messages) or `second` (for outgoing messages) attributes\n* (**optional**) output queue with `publish`, `event` attributes for outgoing events\n\n## Inputs/outputs\n\nThis section describes the messages received and produced by the service\n\n### Inputs\n\nThis service receives messages that will be sent via MQ as `MessageGroup`s, containing a single `RawMessage` with a message body\n\n### Outputs\n\nIncoming and outgoing messages are sent via MQ as `MessageGroup`s, containing a single `RawMessage` with a message body.\n\n## Events\n\nThis section describes the events that can be produced by the service. You can use that information to trigger some actions on certain events.\n\n### Connected\n\nWhen the service is connected it will publish the event with \n**name**=`Connected to: \u003curl\u003e` \nand **type**=`Info`\n\n### Disconnected\n\nWhen the service is disconnected for some reason it will publish the event with\n**name**=`Disconnected from: \u003curi\u003e - statusCode: \u003cstatusCode\u003e, reason: \u003creason\u003e`\nand **type**=`Info`\n\n## Deployment via `infra-mgr`\n\nHere's an example of `infra-mgr` config required to deploy this service\n\n```yaml\napiVersion: th2.exactpro.com/v1\nkind: Th2Box\nmetadata:\n  name: ws-client\nspec:\n  image-name: ghcr.io/th2-net/th2-conn-ws-client\n  image-version: 0.3.1\n  custom-config:\n    uri: wss://echo.websocket.org\n    sessionAlias: api_session\n    grpcStartControl: true\n    autoStart: true\n    autoStopAfter: 300\n    handlerSettings:\n      pingInterval: 30000\n  type: th2-conn\n  pins:\n    - name: to_send\n      connection-type: mq\n      attributes:\n        - subscribe\n        - send\n        - raw\n    - name: outgoing_messages\n      connection-type: mq\n      attributes:\n        - publish\n        - second\n        - raw\n    - name: incoming_messages\n      connection-type: mq\n      attributes:\n        - publish\n        - first\n        - raw\n# Optional pin for sending the events from the service to another box\n#    - name: service_events\n#      connection-type: mq\n#      attributes:\n#        - publish\n#        - event\n```\n\n## Changelog\n\n### v0.3.1\n\n#### Added:\n* common lib update from 3.25.1 to 3.40.0\n* bom lib update from 3.0.0 to 3.1.0\n\n## Changelog\n\n### v0.3.0\n\n#### Added:\n* opportunity to add query params to uri from handler\n\n### v0.2.5\n\n#### Added:\n\n* reconnect if handling of event fails\n* ability to stop client during reconnect loop\n\n### v0.2.4\n\n#### Changed:\n\n* The common version is updated from 3.13.4 to 3.25.1\n* Events are published to all pins that match the requested attributes\n\n### v0.2.3\n\n#### Fixed:\n\n* running-flag wasn't reset if connection has failed during start\n\n### v0.2.2\n\n#### Added:\n\n* cancel ping timer in case of close/error WS events\n\n### v0.2.1\n\n#### Fixed:\n\n* deadlock when trying to send a message from `IHandler.onOpen`\n\n### v0.2.0\n\n#### Added:\n\n* a new `preOpen` method that allows the handler to adjust some client's settings\n* `DefaultHandler` has the parameter to specify default headers for HTTP handshake\n\n### v0.1.1\n\n#### Fixed:\n\n* inverted `autoStart` setting behavior\n* reconnect loop during socket availability check\n\n### v0.1.0\n\n#### Added:\n\n* ability to start/stop via gRPC service\n* auto-start/stop feature\n\n### v0.0.2\n\n#### Fixed:\n\n* high idle CPU usage\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fth2-net%2Fth2-conn-ws-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fth2-net%2Fth2-conn-ws-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fth2-net%2Fth2-conn-ws-client/lists"}