Page History

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

This is the representation of an object from the DSpace database. Since DSpace 6, this object is populated with hibernate.

Rest Object: org.dspace.app.rest.model.DSpaceObject

This is a plain old java object (pojo) representation of a DSpace object.

Coding the REST 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
  
  • https://github.com/DSpace/DSpace/blob/rest7/dspace-spring-rest/src/main/java/org/dspace/app/rest/model/DSpaceObjectRest.java#L34-L68
• To exclude a property from JSON representation, add @JsonIgnore to the get method or to the property
  • https://github.com/DSpace/DSpace/blob/rest7/dspace-spring-rest/src/main/java/org/dspace/app/rest/model/DSpaceObjectRest.java#L23
  • https://github.com/DSpace/DSpace/blob/rest7/dspace-spring-rest/src/main/java/org/dspace/app/rest/model/DSpaceObjectRest.java#L33

Hateoas Object:  org.dspace.app.rest.model.hateoas.DSpaceResource

This representation of an object allows for 

1. the embedding of other DSpace objects within the object
2. linking to other external DSpace objects