Package io.wcm.caravan.rhyme.api.annotations

Annotation Interface ResourceState

@Retention(RUNTIME)
@Target(METHOD)
public @interface ResourceState

Used to declare the method that allows to access the HAL resources' state (all JSON properties except for "_links" and "_embedded") as a single object.

The method must provide either a Jackson ObjectNode or a Java object that that matches the JSON object structure (and can be deserialized by a default Jackson ObjectMapper). This object can either be returned directly from the annotated method, but can also be wrapped with Optional or a supported reactive type.

See Also:

• ResourceProperty