{"id":23651932,"url":"https://github.com/microfocus/octane-websockets-client-java","last_synced_at":"2025-07-16T12:32:53.420Z","repository":{"id":49201903,"uuid":"175392773","full_name":"MicroFocus/octane-websockets-client-java","owner":"MicroFocus","description":"WebSockets client providing connectivity to ALM Octane's endpoints (Java env)","archived":false,"fork":false,"pushed_at":"2023-04-18T22:21:08.000Z","size":37,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-12-28T16:49:02.151Z","etag":null,"topics":["octane"],"latest_commit_sha":null,"homepage":"","language":"Java","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/MicroFocus.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}},"created_at":"2019-03-13T09:53:48.000Z","updated_at":"2022-11-29T18:48:35.000Z","dependencies_parsed_at":"2023-01-22T00:01:39.567Z","dependency_job_id":null,"html_url":"https://github.com/MicroFocus/octane-websockets-client-java","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroFocus%2Foctane-websockets-client-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroFocus%2Foctane-websockets-client-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroFocus%2Foctane-websockets-client-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MicroFocus%2Foctane-websockets-client-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MicroFocus","download_url":"https://codeload.github.com/MicroFocus/octane-websockets-client-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239611992,"owners_count":19668274,"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","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":["octane"],"created_at":"2024-12-28T16:49:08.435Z","updated_at":"2025-02-19T06:50:04.784Z","avatar_url":"https://github.com/MicroFocus.png","language":"Java","readme":"### Summary\n\n`octane-websockets-client` library is dedicated to simplify consumption of Octane's WebSocket APIs by consumers.\n\nThe library provides simple configuration means which used afterwards to establish WS connectivity.\n\nGiven credentials are provided, the `octane-websockets-client` will perform the authentication management against Octane under the hood.\n\nProxy configuration is supported as well.\n\n### Basic walk through\n\nRegular usage of library will involve the below steps:\n- create `OctaneWSClientContext` starting with `OctaneWSClientContext.builder()` API\n- implement your WS endpoint handler extending `OctaneWSEndpointClient`\n- create instance of your WS endpoint with the previously created context object\n- initialize the client with `OctaneWSClientService.getInstance().initClient(client)`\n\nAssuming, that your WS endpoint implementation class is `MyOctaneWSEndpointHandler`, the whole process will look like this:\n\n```java\n//  Octane WS/WSS endpoints will always start from 'messaging'\n//  proxy settings are optionals\nOctaneWSClientContext context = OctaneWSClientContext.builder()\n\t\t.setEndpointUrl(\"ws://some.octane.host:1111/messaging/some/ws/endpoint?param=value\")\n\t\t.setClient(\"your_ws_username\")\n\t\t.setSecret(\"your_ws_password\")\n\t\t.setProxyUrl(\"http://web-proxy.host:2222\")\n\t\t.setProxyUsername(\"proxy_username_if_relevant\")\n\t\t.setProxyPassword(\"proxy_password_if_relevant\")\n\t\t.build();\n\nOctaneWSEndpointClient client = new MyOctaneWSEndpointHandler(context);\nOctaneWSClientService.getInstance().initClient(client);\n\n//  the client is ready to send and receive WS messages\n``` ","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrofocus%2Foctane-websockets-client-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrofocus%2Foctane-websockets-client-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrofocus%2Foctane-websockets-client-java/lists"}