Contribute to the DSpace Development Fund
The newly established DSpace Development Fund supports the development of new features prioritized by DSpace Governance. For a list of planned features see the fund wiki page.
Code Branch
https://github.com/DSpace/DSpace/tree/rest7/dspace-spring-rest
Code Representation of a DSpace Object
DSpace API Object (hibernate): org.dspace.content.DSpaceObject
Rest Object: org.dspace.app.rest.model.DSpaceObject
This is a plain old java object (pojo) representation of a DSpace object.
- Add private properties
- https://github.com/DSpace/DSpace/blob/rest7/dspace-spring-rest/src/main/java/org/dspace/app/rest/model/DSpaceObjectRest.java#L24-L30
- Add a get/set bean methods
- To exclude a property from JSON representation, add @JsonIgnore to the get method or to the property
Hateoas Object: org.dspace.app.rest.model.hateoas.DSpaceResource
This representation of an object allows for
- the embedding of other DSpace objects within the object
- linking to other external DSpace objects
The base class in this package uses reflection to identify attributes that are actual links to other REST resources. On a such attribute is discovered the code
- wrap the linked REST resource inside a DSpaceResource (so to have the identifier, self link, and links to other resources)
- put the wrapper in the embedde
- https://github.com/DSpace/DSpace/blob/rest7/dspace-spring-rest/src/main/java/org/dspace/app/rest/model/hateoas/DSpaceResource.java#L45-L74
- TODO: summarize in plain language the decisions that this code is making
Converter Object: org.dspace.app.rest.converter.DSpaceObjectConverter
Convert between the REST representation of an object and the hibernate representation of an object
Coding a converter object
- In the fromModel() function, map all object attributes from the persistence/hibernate model to the rest model
Overview
Content Tools
All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license
, unless otherwise noted.