{"id":13740740,"url":"https://github.com/dbmdz/iiif-apis","last_synced_at":"2026-02-14T14:37:14.230Z","repository":{"id":25417185,"uuid":"103931456","full_name":"dbmdz/iiif-apis","owner":"dbmdz","description":"Java Domain Models for all IIIF APIs","archived":false,"fork":false,"pushed_at":"2026-01-19T00:25:06.000Z","size":667,"stargazers_count":27,"open_issues_count":11,"forks_count":11,"subscribers_count":8,"default_branch":"main","last_synced_at":"2026-01-19T10:24:54.514Z","etag":null,"topics":["iiif","iiif-annotations","iiif-auth","iiif-image","iiif-presentation","iiif-search"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dbmdz.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-09-18T11:40:06.000Z","updated_at":"2025-08-13T11:17:33.000Z","dependencies_parsed_at":"2025-11-30T15:04:07.298Z","dependency_job_id":null,"html_url":"https://github.com/dbmdz/iiif-apis","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/dbmdz/iiif-apis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbmdz%2Fiiif-apis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbmdz%2Fiiif-apis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbmdz%2Fiiif-apis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbmdz%2Fiiif-apis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbmdz","download_url":"https://codeload.github.com/dbmdz/iiif-apis/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbmdz%2Fiiif-apis/sbom","scorecard":{"id":329014,"data":{"date":"2025-08-11","repo":{"name":"github.com/dbmdz/iiif-apis","commit":"1ae288856ba1825756066c730ef92f58f1811159"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.4,"checks":[{"name":"Maintained","score":2,"reason":"3 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.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":"Code-Review","score":5,"reason":"Found 1/2 approved changesets -- score normalized to 5","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":"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":"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.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/dbmdz/iiif-apis/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/dbmdz/iiif-apis/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/dbmdz/iiif-apis/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/dbmdz/iiif-apis/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/dbmdz/iiif-apis/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/dbmdz/iiif-apis/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:75: update your workflow using https://app.stepsecurity.io/secureworkflow/dbmdz/iiif-apis/ci.yml/main?enable=pin","Info:   0 out of   7 GitHub-owned GitHubAction 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":"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":"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":"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":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: 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":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 0.3.8 not signed: https://api.github.com/repos/dbmdz/iiif-apis/releases/26381032","Warn: release artifact 0.3.7 not signed: https://api.github.com/repos/dbmdz/iiif-apis/releases/16059566","Warn: release artifact 0.3.8 does not have provenance: https://api.github.com/repos/dbmdz/iiif-apis/releases/26381032","Warn: release artifact 0.3.7 does not have provenance: https://api.github.com/repos/dbmdz/iiif-apis/releases/16059566"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/ci.yml:37"],"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 29 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"}},{"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"}}]},"last_synced_at":"2025-08-18T03:08:33.320Z","repository_id":25417185,"created_at":"2025-08-18T03:08:33.320Z","updated_at":"2025-08-18T03:08:33.320Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29447410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-14T14:10:32.461Z","status":"ssl_error","status_checked_at":"2026-02-14T14:09:49.945Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["iiif","iiif-annotations","iiif-auth","iiif-image","iiif-presentation","iiif-search"],"created_at":"2024-08-03T04:00:51.776Z","updated_at":"2026-02-14T14:37:14.213Z","avatar_url":"https://github.com/dbmdz.png","language":"Java","funding_links":[],"categories":["Presentation API Libraries"],"sub_categories":["Image viewers (Image API only)"],"readme":"# iiif-apis\n\n[![Image API 2.1.1 compliant](https://img.shields.io/badge/iiif--image--api-≤2.1.1-blue.svg)](https://iiif.io/api/image/2.1/)\n[![Presentation API 2.1.1 compliant](https://img.shields.io/badge/iiif--presentation--api-≤2.1.1-blue.svg)](https://iiif.io/api/presentation/2.1/)\n[![Authentication API 1.0 compliant](https://img.shields.io/badge/iiif--authentication--api-1.0-blue.svg)](https://iiif.io/api/auth/1.0/)\n[![Search API 1.0 compliant](https://img.shields.io/badge/iiif--search--api-1.0-blue.svg)](https://iiif.io/api/search/1.0/)\n\n[![Javadocs](https://javadoc.io/badge/de.digitalcollections.iiif/iiif-apis.svg)](https://javadoc.io/doc/de.digitalcollections.iiif/iiif-apis)\n[![License](https://img.shields.io/github/license/dbmdz/iiif-apis.svg)](LICENSE)\n[![GitHub release](https://img.shields.io/github/release/dbmdz/iiif-apis.svg)](https://github.com/dbmdz/iiif-apis/releases)\n[![Maven Central](https://img.shields.io/maven-central/v/de.digitalcollections.iiif/iiif-apis.svg)](https://central.sonatype.com/search?q=iiif-apis)\n\nThis module contains model classes for all currently available IIIF API entities, namely for the\n[Presentation](http://iiif.io/api/presentation/2.1/), [Image](http://iiif.io/api/image/2.1/),\n[Content Search](http://iiif.io/api/search/1.0/) and [Authentication](http://iiif.io/api/auth/1.0/) APIs, as well as\nthe additional services defined in the [Service Annex](http://iiif.io/api/annex/services/). It also includes all the\nnecessary components to parse and create valid JSON-LD representations of these entities, using\n[Jackson](https://github.com/FasterXML/jackson).\n\nThe library contains a comprehensive test suite for all entities, based on all of the examples\nprovided in the IIIF specifications. Therefore, it should be able to parse and create any IIIF\ndocuments that are compliant with the official specifications. If you find that you cannot parse\na IIIF entity that you believe to be correct, please [submit an issue](https://github.com/dbmdz/iiif-apis/issues) including a link to\nthe JSON-LD representation of the entity. Likewise, if you find that you cannot express\na certain IIIF construct with the Java API, let us know.\n\nIt is intended to replace both [iiif-presentation-api](https://github.com/dbmdz/iiif-presentation-api)\nand [iiif-image-api](https://github.com/dbmdz/iiif-image-api) once it is stable enough, with the non-model\nparts of these libraries being moved into [hymir](https://github.com/dbmdz/iiif-server-hymir).\n\n## Usage\nTo use the module, first add it to your project's Maven or Gradle configuration:\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ede.digitalcollections.iiif\u003c/groupId\u003e\n  \u003cartifactId\u003eiiif-apis\u003c/artifactId\u003e\n  \u003cversion\u003e0.3.10\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n```scala\ndependencies {\n    compile 'de.digitalcollections.iiif.iiif-apis:0.3.10'\n}\n```\n\nFor both reading and writing IIIF JSON-LD documents, it is neccessary to instantiate the Jackson\nobject mapper:\n\n```java\nimport de.digitalcollections.iiif.model.jackson.IiifObjectMapper;\n\nObjectMapper iiifMapper = new IiifObjectMapper();\n```\n\nThe mapper can then be used to read IIIF JSON-LD documents into their corresponding Java object:\n\n```java\nimport de.digitalcollections.iiif.model.sharedcanvas.Manifest;\n\n// Reading a manifest\nManifest manifest = iiifMapper.readValue(\n    \"http://iiif.biblissima.fr/manifests/ark:/12148/btv1b8304502m/manifest.json\",\n    Manifest.class);\n\n// Reading an annotation list\nAnnotationList annoList = iiifMapper.readValue(\n    \"http://dams.llgc.org.uk/iiif/4342443/annotation/list/ART8.json\",\n    AnnotationList.class);\n```\n\nTo create your own IIIF entities, just model them using the available classes and use the\nobject mapper to obtain their JSON-LD representation:\n\n```java\nimport de.digitalcollections.iiif.model.sharedcanvas.Canvas;\nimport de.digitalcollections.iiif.model.ImageContent;\nimport de.digitalcollections.iiif.model.image.ImageApiProfile;\nimport de.digitalcollections.iiif.model.image.ImageService;\nimport de.digitalcollections.iiif.model.OtherContent;\nimport de.digitalcollections.iiif.model.search.ContentSearchService;\nimport de.digitalcollections.iiif.model.PropertyValue;\n\nimport java.util.Locale;\n\n\nCanvas canvas = new Canvas(\"http://some.uri\");\ncanvas.addLabel(\"A label\");\ncanvas.addDescription(\"This is a slightly longer text about this canvas.\");\ncanvas.setWidth(800);\ncanvas.setHeight(600);\n\n// Image\ncanvas.addIIIFImage(\"http://some.uri/iiif/foo\", ImageApiProfile.LEVEL_ONE);\n\n// Thumbnail\nImageContent thumbnail = new ImageContent(\"http://some.uri/iiif/foo/full/250,/0/default.jpg\");\nthumbnail.addService(new ImageService(\"http://some.uri/iiif/foo\", ImageApiProfile.LEVEL_ONE));\ncanvas.addThumbnail(thumbnail);\n\n// Other Content\ncanvas.addSeeAlso(new OtherContent(\"http://some.uri/ocr/foo.hocr\", \"text/html\"));\n\n// Search Service\nContentSearchService searchService = new ContentSearchService(\"http://some.uri/search/foo\");\nsearchService.addAutocompleteService(\"http://some.uri/autocomplete/foo\");\ncanvas.addService(searchService);\n\n// Metadata\ncanvas.addMetadata(\"Author\", \"Ignatius Jacques Reilly\");\ncanvas.addMetadata(\"Location\", \"New Orleans\");\nPropertyValue key = new PropertyValue();\nkey.addValue(Locale.ENGLISH, \"Key\");\nkey.addValue(Locale.GERMAN, \"Schlüssel\");\nkey.addValue(Locale.CHINESE, \"钥\");\nPropertyValue value = new PropertyValue();\nvalue.addValue(Locale.ENGLISH, \"A value\", \"Another value\");\nvalue.addValue(Locale.GERMAN, \"Ein Wert\", \"Noch ein Wert\");\nvalue.addValue(Locale.CHINESE, \"值\", \"另值\");\ncanvas.addMetadata(new MetadataEntry(key, value));\n\n// Other stuff\ncanvas.addViewingHint(ViewingHint.NON_PAGED);\n\n// Licensing/Attribution\ncanvas.addLicense(\"http://rightsstatements.org/vocab/NoC-NC/1.0/\");\ncanvas.addAttribution(\"Some fictional institution\");\ncanvas.addLogo(\"http://some.uri/logo.jpg\");\ncanvas.addLogo(new ImageContent(new ImageService(\n    \"http://some.uri/iiif/logo\", ImageApiProfile.LEVEL_ONE)));\n\nString json = iiifMapper.writerWithDefaultPrettyPrinter().writeValueAsString(canvas);\n```\n\nFor more information on how to use the API, consult the\n[API documentation](http://javadoc.io/doc/de.digitalcollections.iiif/iiif-apis)\nand the [comprehensive test suite](https://github.com/dbmdz/iiif-apis/tree/master/src/test/java/de/digitalcollections/iiif/model).\nSince the large majority of the tests are based on the examples from the  specifications, they should be very easy to\nfollow along.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbmdz%2Fiiif-apis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbmdz%2Fiiif-apis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbmdz%2Fiiif-apis/lists"}