{"id":37027668,"url":"https://github.com/mhartle/haley","last_synced_at":"2026-01-14T03:17:42.688Z","repository":{"id":54427054,"uuid":"181682304","full_name":"mhartle/haley","owner":"mhartle","description":"Haley HAL Resource Builder for Java","archived":false,"fork":false,"pushed_at":"2022-11-15T23:51:30.000Z","size":36,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-15T03:08:13.349Z","etag":null,"topics":["hal","hateoas","jackson","java","jersey","json","rest","spring","web"],"latest_commit_sha":null,"homepage":"","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/mhartle.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}},"created_at":"2019-04-16T12:10:56.000Z","updated_at":"2020-03-03T17:04:27.000Z","dependencies_parsed_at":"2022-08-13T15:20:25.207Z","dependency_job_id":null,"html_url":"https://github.com/mhartle/haley","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/mhartle/haley","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhartle%2Fhaley","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhartle%2Fhaley/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhartle%2Fhaley/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhartle%2Fhaley/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mhartle","download_url":"https://codeload.github.com/mhartle/haley/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhartle%2Fhaley/sbom","scorecard":{"id":639850,"data":{"date":"2025-08-11","repo":{"name":"github.com/mhartle/haley","commit":"9d47b1b1d18224ef9581a605c8973db485279381"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/13 approved changesets -- score normalized to 0","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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"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":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"Vulnerabilities","score":3,"reason":"7 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-h46c-h94j-95f3","Warn: Project is vulnerable to: GHSA-wf8f-6423-gfxg","Warn: Project is vulnerable to: GHSA-288c-cq4h-88gq","Warn: Project is vulnerable to: GHSA-3x8x-79m2-3w2w","Warn: Project is vulnerable to: GHSA-57j2-w4cx-62h2","Warn: Project is vulnerable to: GHSA-jjjh-jjxp-wpff","Warn: Project is vulnerable to: GHSA-rgv9-q543-rqg4"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T10:23:36.361Z","repository_id":54427054,"created_at":"2025-08-21T10:23:36.361Z","updated_at":"2025-08-21T10:23:36.361Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28408824,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"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":["hal","hateoas","jackson","java","jersey","json","rest","spring","web"],"created_at":"2026-01-14T03:17:41.940Z","updated_at":"2026-01-14T03:17:42.680Z","avatar_url":"https://github.com/mhartle.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Haley HAL Resource Builder for Java\n\n## Overview\n\n* Haley is a builder for Hypertext Application Language (HAL) resources as\n  per [draft-kelly-json-hal-08](https://www.ietf.org/archive/id/draft-kelly-json-hal-08.txt)\n  for web service controllers written in Java. It uses Jackson for the\n  serialization and deserialization of HAL JSON resources.\n\n* The library is useful for Hypertext As The Engine Of Application State\n  (HATEOAS)-based applications. It allows you to build HAL resources\n  through a fluent builder API including support for links, embedded\n  resources and CURIEs.\n\n## Dependency\n\n### Maven\n\n```\n\t\u003cdependency\u003e\n\t\t\u003cgroupId\u003ecom.hartle-klug\u003c/groupId\u003e\n\t\t\u003cartifactId\u003ehaley\u003c/artifactId\u003e\n\t\t\u003cversion\u003e1.0.1\u003c/version\u003e\n\t\u003c/dependency\u003e\n```\n\n### Gradle\n\n```\n\tcompile group: 'com.hartle-klug', name: 'haley', version: '1.0.1'\n```\n\n## Usage\n\n* Import the respective builder classes to your Java class\n\n```\n\timport com.hartle_klug.haley.builder.ResourceBuilder;\n\timport com.hartle_klug.haley.builder.RepresentationBuilder;\n\timport com.hartle_klug.haley.builder.PropertyBuilder;\n\timport com.hartle_klug.haley.builder.LinkBuilder;\n```\n\n* Use the builders accordingly; eg. to create an fictious Account HAL\n  resource for a user John Smith who has two repositories, the following\n  code snippet\n\n```\n\tfinal Resource accountResource =\n\t\tResourceBuilder.use(\n\t\t\tRepresentationBuilder.use()\n\t\t\t.property(PropertyBuilder.use(\"name\", \"John Smith\").build())\n\t\t\t.build())\n\t\t.linkSelf(\n\t\t\tLinkBuilder.use(\"http://company.com/account/jsmith\")\n\t\t\t.profile(\"http://company.com/ns/account\")\n\t\t\t.build())\n\t\t.curie(\n\t\t\tLinkBuilder.use(\"http://company.com/ns/account/{rel}\")\n\t\t\t.templated(true)\n\t\t\t.name(\"account\")\n\t\t\t.build())\n\t\t.link(\"account:update\",\n\t\t\tLinkBuilder.use(\"http://company.com/account/jsmith/update\")\n\t\t\t.build())\n\t\t.embedd(\"repositories\",\n\t\t\tResourceBuilder.use(\n\t\t\t\tRepresentationBuilder.use()\n\t\t\t\t.property(PropertyBuilder.use(\"name\", \"One Sample Repo\").build())\n\t\t\t\t.build())\n\t\t\t.linkSelf(\n\t\t\t\tLinkBuilder.use(\"http://company.com/account/jsmith/repo/one-sample-repo\")\n\t\t\t\t.profile(\"http://company.com/ns/repository\")\n\t\t\t\t.build())\n\t\t\t.build(),\n\t\t\t\n\t\t\tResourceBuilder.use(\n\t\t\t\tRepresentationBuilder.use()\n\t\t\t\t.property(PropertyBuilder.use(\"name\", \"Another Sample Repo\").build())\n\t\t\t\t.build())\n\t\t\t.linkSelf(\n\t\t\t\tLinkBuilder.use(\"http://company.com/account/jsmith/repo/another-sample-repo\")\n\t\t\t\t.profile(\"http://company.com/ns/repository\")\n\t\t\t\t.build())\n\t\t\t.build())\n\t\t.build();\n```\n\nproduces a HAL resource that Jackson (either implicitly in a Spring / Jersey controller or explicitly\nthrough the use of the ObjectMapper method writeValueAsString) serializes as\n\n```\n{\n  \"name\": \"John Smith\",\n  \"_links\": {\n    \"self\": {\n      \"profile\": \"http://company.com/ns/account/account\",\n      \"href\": \"http://company.com/account/jsmith\"\n    },\n    \"account:update\": {\n      \"href\": \"http://company.com/account/jsmith/update\"\n    },\n    \"curies\": [\n      {\n        \"name\": \"account\",\n        \"href\": \"http://company.com/ns/account/{rel}\",\n        \"templated\": true\n      }\n    ]\n  },\n  \"_embedded\": {\n    \"repositories\": [\n      {\n        \"name\": \"One Sample Repo\",\n        \"_links\": {\n          \"self\": {\n            \"profile\": \"http://company.com/ns/repository\",\n            \"href\": \"http://company.com/account/jsmith/repo/one-sample-repo\"\n          }\n        }\n      },\n      {\n        \"name\": \"Another Sample Repo\",\n        \"_links\": {\n          \"self\": {\n            \"profile\": \"http://company.com/ns/repository\",\n            \"href\": \"http://company.com/account/jsmith/repo/another-sample-repo\"\n          }\n        }\n      }\n    ]\n  }\n}\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmhartle%2Fhaley","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmhartle%2Fhaley","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmhartle%2Fhaley/lists"}