RESTful Java Web Services - Third Edition

Declaratively building HTTP link headers using @InjectLinks

RFC 5988 mentions about defining Links in a HTTP header using the Link Header field. Adding links to a header is useful for capturing the metadata of a resource, for example, license information, policy information, and so on. To declaratively add the Link Header field, you can use @InjectLinks to add HTTP link headers as well. Here is an example:

@InjectLinks({ 
  @InjectLink( 
    value = "{id}/employees/{managerId}", 
    style = Style.RELATIVE_PATH, 
    bindings = { 
      @Binding(name = "id", value =  
        "${instance.departmentId}"), 
      @Binding(name = "managerId", value =  
        "${instance.managerId}")}, 
    rel = "manager" 
  )})@XmlRootElement  
public class DepartmentRepresentation { 
.... 
} 

This generates the following ...