{"id":21665102,"url":"https://github.com/galan/dms-exchange-java","last_synced_at":"2026-05-19T02:03:53.518Z","repository":{"id":21829515,"uuid":"25152520","full_name":"galan/dms-exchange-java","owner":"galan","description":"Implementation of the dms-exchange-specification in java","archived":false,"fork":false,"pushed_at":"2017-09-13T15:03:40.000Z","size":326,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-25T08:07:54.555Z","etag":null,"topics":["dms","exchange","export","import","java","transfer"],"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/galan.png","metadata":{"files":{"readme":"README.md","changelog":"changes.md","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":"2014-10-13T09:40:57.000Z","updated_at":"2016-01-12T07:51:39.000Z","dependencies_parsed_at":"2022-08-20T00:00:35.802Z","dependency_job_id":null,"html_url":"https://github.com/galan/dms-exchange-java","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galan%2Fdms-exchange-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galan%2Fdms-exchange-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galan%2Fdms-exchange-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galan%2Fdms-exchange-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/galan","download_url":"https://codeload.github.com/galan/dms-exchange-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244562170,"owners_count":20472598,"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":["dms","exchange","export","import","java","transfer"],"created_at":"2024-11-25T10:48:59.246Z","updated_at":"2026-05-19T02:03:53.485Z","avatar_url":"https://github.com/galan.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://img.shields.io/travis/galan/dms-exchange-java.svg?style=flat)](https://travis-ci.org/galan/dms-exchange-java)\n[![Maven Central](https://img.shields.io/maven-central/v/de.galan/dms-exchange-java.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/de.galan/dms-exchange-java)\n[![License](https://img.shields.io/github/license/galan/dms-exchange-java.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0.html)\n\nThis java-library is the reference-implementation for the [dms-exchange-specification](https://github.com/galan/dms-exchange-specification). It covers the following use-cases:\n* Creating new export-archives and adding document-containers\n* Reading existing document-container from existing export-archives\n\nThe library can be used in any existing dms/software to enable support for the dms-exchange-specification. It is licenced under the conditions of the Apache License 2.0 (see LICENCE file).\n\n# Usage\n\n## Creating an export-archive\nCreate the writer using one of the convenience construction methods from DmsExchange: \n\n    DmsWriter writer = DmsExchange.createWriter(\"/path/to/archive.tgz\");\n\nFeed the writer with documents:\n\n    writer.add(...);\n\nAs last step, close the writer (AutoClosable can be used):\n\n    writer.close();\n\nOther writer also support writing to OutputStreams or splitting files depending on conditions, such as amount of document or filesize.\n\n\n## Reading an export-archive\nCreate the reader using one of the convenience construction methods from DmsExchange: \n\n    DmsReader reader = DmsExchange.createReader(\"/path/to/archive.tgz\");\n\nRead the documents using a single consumer:\n\n    reader.readDocuments(document -\u003e /* eg. import to your system */);\n\n# Document\nDocuments are simple java beans, they can be instantiated using `new`, fields are accessed using the according setter/getter accessor methods. Fluent setters are also available.\n\nExample of creating a minimal `Document` with some fields:\n\n    // Source keeps same, use a constant\n\tprivate static final Source SOURCE = new Source(\"dms-name\", null, \"https://www.example.com\", \"contact@example.com\");\n    \n    Document doc = new Document().source(SOURCE);\n    DocumentFile docfile = new DocumentFile(\"car-insurance-2014.pdf\");\n    docfile.addRevision(new Revision(/*documentfile creation-time*/).data(byte[] or InputStream or File));\n    doc.addDocumentFile(docfile);\n    // use a setter\n    doc.setNote(\"Keep an eye on this\");\n    // or the fluent methods\n    doc.note(\"Keep an eye on this\").labels(\"important\", \"invoice\").project(\"insurance\");\n\n# Compatiblity\ndms-exchange-java supports the [dms-exchange-specification](https://github.com/galan/dms-exchange-specification) version 1.0.0.\n\nWhen newer versions of dms-exchange-specification will be released, this library is designed to be backward compatible. \n\n# Integration with Maven\nJust add the following dependency:\n\n    \u003cdependency\u003e\n    \t\u003cgroupId\u003ede.galan\u003c/groupId\u003e\n    \t\u003cartifactId\u003edms-exchange-java\u003c/artifactId\u003e\n    \t\u003cversion\u003e1.0.2\u003c/version\u003e\n    \u003c/dependency\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalan%2Fdms-exchange-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgalan%2Fdms-exchange-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalan%2Fdms-exchange-java/lists"}