{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Main Page","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25461463"}}]},{"text":" ","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"outline":{"value":"true"},"indent":{"value":"20px"},"style":{"value":"none"},"printable":{"value":"false"}},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Serializer","type":"text"}]},{"type":"paragraph","content":[{"text":"MetadataSerializer","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":" ","type":"text"},{"text":"is responsible for serializing and deserializing OpenmrsObjects. It is build upon","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":" ","type":"text"},{"text":"XStream","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":" ","type":"text"},{"text":"library and uses XML format. It is able to produce a list of metadata with all related items and a package header that contains information such as name, description, creation date, OpenMRS version. They are stored in two separate files called metadata.xml and header.xml and packaged in a zip file.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]},{"type":"paragraph","content":[{"text":"You can implement the ","type":"text"},{"text":"writeReplace/readResolve","type":"text","marks":[{"type":"strong"}]},{"text":" methods in your shareable class if you want to provide a custom serialization. It needs to conform standard rules specified in the Java documentation. You can use it to provide extra dependencies for your object which you need to export together with your object. Typically it is not needed since all fields of your object will be examined and references to other objects resolved and serialized as well. However, you will need to define an extra field for dependencies and initialize it in the writeReplace method, if you reference objects in xmls or other text formats.","type":"text"}]},{"type":"paragraph","content":[{"text":"You may also consider implementing ","type":"text"},{"text":"void onSave(Map incomingToExisting)","type":"text","marks":[{"type":"strong"}]},{"text":". This method will be called by the Metadata Sharing module on your object upon importing. The map parameter contains a map with keys pointing to items included in the package and values pointing to existing items that should be used instead by your object. Typically, you will use the map to replace all incoming uuids with existing uuids in xmls and other text formats. It is not needed to replace Java references in your object since they will be replaced by the Metadata Sharing module automatically.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can see a reference implementation of this mechanism in ","type":"text"},{"text":"HTML Form Entry Module","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/docs/pages/25475242"}}]},{"text":" under ","type":"text"},{"text":"HTML-184","type":"text","marks":[{"type":"link","attrs":{"href":"https://tickets.openmrs.org/browse/HTML-184"}},{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Handler","type":"text"}]},{"type":"paragraph","content":[{"text":"Handler is an interface that can be implemented to support different kinds of metadata. A custom handler can be registered in HandlerFactory. There is ConceptHandler that provides support for org.openmrs.Concept. Apart from that there are OpenmrsMetadataHandler and OpenmrsObjectHandler. They provide with just a basic support for classes implementing OpenmrsMetadata and OpenmrsObject. OpenmrsMetadataHandler in particular determines at runtime a list of classes on the classpath that can be exported.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Publish/subscribe protocol ","type":"text"}]},{"type":"paragraph","content":[{"text":"A published package is accessible through a URL which consists of 5 parts:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"URL prefix - specifies the way the server can be accessed through the Internet and the application context path. This is typically ","type":"text"},{"text":"http://localhost:8080/openmrs","type":"text","marks":[{"type":"em"}]},{"text":" in development and ","type":"text"},{"text":"http://example.com/openmrs","type":"text","marks":[{"type":"em"}]},{"text":" in production.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/ws/rest/metadatasharing/package/","type":"text","marks":[{"type":"em"}]},{"text":" to follow OpenMRS REST patterns","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"UUID of the package group (a mutual UUID along all package versions)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/latest","type":"text","marks":[{"type":"em"}]},{"text":" which indicates that the subscriber will lookup for the latest version from the package group","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"(optional) ","type":"text"},{"text":".form","type":"text","marks":[{"type":"em"}]},{"text":" suffix required on OpenMRS versions which do not support web services. Note: after upgrading OpenMRS from e.g. 1.6.x to 1.8.1+, the publish URLs lose this suffix, but old URLs remain accessible. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example of a publish URL: http:/localhost:8080/openmrs/ws/rest/metadatasharing/package/7f2d4731-0a98-4118-8fe0-d4b9731986c6/latest","type":"text"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"},{"text":"Example of a curl to this URL","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":" ","type":"text"}]}]}]}]},{"type":"codeBlock","content":[{"text":"\n\n \n 2011-08-18 00:30:45\n Roles\n All available roles\n 1.8.2 Build 21762\n 5\n 7f2d4731-0a98-4118-8fe0-d4b9731986c6\n \n ../7f2d4731-0a98-4118-8fe0-d4b9731986c6/5/download\n","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"packageHeader","type":"text","marks":[{"type":"strong"}]},{"text":" node contains all header information about the package. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"contentUri","type":"text","marks":[{"type":"strong"}]},{"text":" node is a relative URI to the place where we can download zipped package with all metadata. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The download URL is similar to publish URL, but it ends with: ","type":"text"},{"text":"%VERSION","type":"text","marks":[{"type":"em"}]},{"text":"/download. This allows us to download any published version of the package, but this feature is not used yet. ","type":"text"}]}],"version":1}