Index

A C E F H I L M N P R S T U V 
All Classes and Interfaces|All Packages|Constant Field Values

A

ABOUT - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Refers to a resource that is the subject of the link's context.
ABOUT - Static variable in class io.wcm.caravan.rhyme.api.relations.VndErrorRelations
Relation to use for links to the resources for which an error has occurred
ALTERNATE - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Refers to a substitute for this context

C

CANONICAL - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Designates the preferred version of a resource (the IRI and its contents).
COLLECTION - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
The target IRI points to a resource which represents the collection resource for the context IRI.
contentType() - Element in annotation interface io.wcm.caravan.rhyme.api.annotations.HalApiInterface
Allows to define a custom content type that is used when rendering server-side resource instances implementing this interface
createLink() - Method in interface io.wcm.caravan.rhyme.api.resources.LinkableResource
Create a link to this resource, including meaningful title and name properties where appropriate.
CURIES - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
A reserved link relation which you can use to hint at the location of resource documentation.

E

EmbeddableResource - Interface in io.wcm.caravan.rhyme.api.resources
An interface that server-side resources should implement if it's reasonable to embed them into the context resource.
ERRORS - Static variable in class io.wcm.caravan.rhyme.api.relations.VndErrorRelations
Relation to use for embedded resources with additional information on the root cause
ExcludeFromJacocoGeneratedReport - Annotation Interface in io.wcm.caravan.rhyme.tooling.annotations
A marker annotation only relevant for static code analysis.
EXTERNAL - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Refers to a resource that is not part of the same site as the current context.

F

FIRST - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
An IRI that refers to the furthest preceding resource in a series of resources.

H

HalApiInterface - Annotation Interface in io.wcm.caravan.rhyme.api.annotations
A marker annotation that is required for all HAL API interfaces to be used with the Rhyme framework.

I

INDEX - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Refers to an index.
io.wcm.caravan.rhyme.api.annotations - package io.wcm.caravan.rhyme.api.annotations
The annotations used in interfaces that define HAL APIs
io.wcm.caravan.rhyme.api.relations - package io.wcm.caravan.rhyme.api.relations
Constants for standard link relations
io.wcm.caravan.rhyme.api.resources - package io.wcm.caravan.rhyme.api.resources
Base interfaces for server-side HAL resource implementations
io.wcm.caravan.rhyme.tooling.annotations - package io.wcm.caravan.rhyme.tooling.annotations
Additional annotations that are only used at build time
isEmbedded() - Method in interface io.wcm.caravan.rhyme.api.resources.EmbeddableResource
Determines if this resource should be embedded (rather than just linked to) from the context resource that created the resource implementation instance
isLinkedWhenEmbedded() - Method in interface io.wcm.caravan.rhyme.api.resources.EmbeddableResource
Determines if this resource should also be linked when it's already embedded in its context resource
ITEM - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
The target IRI points to a resource that is a member of the collection represented by the context IRI.

L

LAST - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
An IRI that refers to the furthest following resource in a series of resources.
LinkableResource - Interface in io.wcm.caravan.rhyme.api.resources
An interface to be implemented by all resources that should be accessible directly via a URL (and therefore can be linked to from another resource).

M

MEMENTO - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
The Target IRI points to a Memento, a fixed resource that will not change state anymore

N

NEXT - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Indicates that the link's context is a part of a series, and that the next in the series is the link target.

P

PREV - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Indicates that the link's context is a part of a series, and that the previous in the series is the link target.

R

Related - Annotation Interface in io.wcm.caravan.rhyme.api.annotations
Used to declare methods which defines a link relation and the expected type for linked or embedded resources.
RELATED - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Identifies a related resource.
ResourceLink - Annotation Interface in io.wcm.caravan.rhyme.api.annotations
Used to declare a method that provides a link to the resource instance.
ResourceProperty - Annotation Interface in io.wcm.caravan.rhyme.api.annotations
Used to declare methods that allow to access a single JSON property of a HAL resource's state.
ResourceRepresentation - Annotation Interface in io.wcm.caravan.rhyme.api.annotations
Used to declare the method that allows clients to get the full JSON representation of the resource (including the _links and _embedded properties).
ResourceState - Annotation Interface in io.wcm.caravan.rhyme.api.annotations
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.

S

SEARCH - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Refers to a resource that can be used to search through the link's context and related resources.
SECTION - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Refers to a section in a collection of resources.
SELF - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Conveys an identifier for the link's context.
StandardRelations - Class in io.wcm.caravan.rhyme.api.relations
Constants for some standard link relations used in Related annotations.
SUBSECTION - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Refers to a resource serving as a subsection in a collection of resources.

T

TemplateVariable - Annotation Interface in io.wcm.caravan.rhyme.api.annotations
Annotation to be used on parameters of methods annotated with Related to define the name of the variable in the URI template that corresponds to the given parameter value.
TemplateVariables - Annotation Interface in io.wcm.caravan.rhyme.api.annotations
Annotation to be used on parameters of methods annotated with Related to define a single DTO parameter that is used to expand multiple template variables.

U

UP - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Refers to a parent document in a hierarchy of documents.

V

value() - Element in annotation interface io.wcm.caravan.rhyme.api.annotations.Related
Defines the relation of the linked or embedded resource to this context resource.
value() - Element in annotation interface io.wcm.caravan.rhyme.api.annotations.ResourceProperty
Allows to override the name of the JSON property (by default it's derived from the method name)
value() - Element in annotation interface io.wcm.caravan.rhyme.api.annotations.TemplateVariable
 
VIA - Static variable in class io.wcm.caravan.rhyme.api.relations.StandardRelations
Identifies a resource that is the source of the information in the link's context.
VndErrorRelations - Class in io.wcm.caravan.rhyme.api.relations
Link relations used by the application/vnd.error+json media type
A C E F H I L M N P R S T U V 
All Classes and Interfaces|All Packages|Constant Field Values