Uses of Interface
org.springframework.hateoas.LinkRelation
Package
Description
Value objects to ease creating
Link
s and link driven representations for REST
webservices.Client side support.
Value objects to build Collection+JSON representations.
HAL-specific extensions, SPIs and Jackson customizations.
UBER media type objects.
Server-side components for hypermedia handling.
Implementations of core API interfaces.
Spring MVC helper classes to build
Link
s and assemble
RepresentationModel
types.Spring WebFlux components to build
Link
s and assemble
RepresentationModel
types.-
Uses of LinkRelation in org.springframework.hateoas
Modifier and TypeFieldDescriptionstatic final LinkRelation
IanaLinkRelations.ABOUT
Refers to a resource that is the subject of the link's context.static final LinkRelation
IanaLinkRelations.ALTERNATE
Refers to a substitute for this contextstatic final LinkRelation
IanaLinkRelations.APPENDIX
Refers to an appendix.static final LinkRelation
IanaLinkRelations.ARCHIVES
Refers to a collection of records, documents, or other materials of historical interest.static final LinkRelation
IanaLinkRelations.AUTHOR
Refers to the context's author.static final LinkRelation
IanaLinkRelations.BLOCKED_BY
Identifies the entity that blocks access to a resource following receipt of a legal demand.static final LinkRelation
IanaLinkRelations.BOOKMARK
Gives a permanent link to use for bookmarking purposes.static final LinkRelation
IanaLinkRelations.CANONICAL
Designates the preferred version of a resource (the IRI and its contents).static final LinkRelation
IanaLinkRelations.CHAPTER
Refers to a chapter in a collection of resources.static final LinkRelation
IanaLinkRelations.CITE_AS
Indicates that the link target is preferred over the link context for the purpose of referencing.static final LinkRelation
IanaLinkRelations.COLLECTION
The target IRI points to a resource which represents the collection resource for the context IRI.static final LinkRelation
IanaLinkRelations.CONTENTS
Refers to a table of contents.static final LinkRelation
IanaLinkRelations.CONVERTED_FROM
The document linked to was later converted to the document that contains this link relation.static final LinkRelation
IanaLinkRelations.COPYRIGHT
Refers to a copyright statement that applies to the link's context.static final LinkRelation
IanaLinkRelations.CREATE_FORM
The target IRI points to a resource where a submission form can be obtained.static final LinkRelation
IanaLinkRelations.CURRENT
Refers to a resource containing the most recent item(s) in a collection of resources.static final LinkRelation
IanaLinkRelations.DESCRIBED_BY
Refers to a resource providing information about the link's context.static final LinkRelation
IanaLinkRelations.DESCRIBES
The relationship A 'describes' B asserts that resource A provides a description of resource B.static final LinkRelation
IanaLinkRelations.DISCLOSURE
Refers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified.static final LinkRelation
IanaLinkRelations.DNS_PREFETCH
Used to indicate an origin that will be used to fetch required resources for the link context, and that the user agent ought to resolve as early as possible.static final LinkRelation
IanaLinkRelations.DUPLICATE
Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI.static final LinkRelation
IanaLinkRelations.EDIT
Refers to a resource that can be used to edit the link's context.static final LinkRelation
IanaLinkRelations.EDIT_FORM
The target IRI points to a resource where a submission form for editing associated resource can be obtained.static final LinkRelation
IanaLinkRelations.EDIT_MEDIA
Refers to a resource that can be used to edit media associated with the link's context.static final LinkRelation
IanaLinkRelations.ENCLOSURE
Identifies a related resource that is potentially large and might require special handling.static final LinkRelation
IanaLinkRelations.FIRST
An IRI that refers to the furthest preceding resource in a series of resources.static final LinkRelation
IanaLinkRelations.GLOSSARY
Refers to a glossary of terms.static final LinkRelation
IanaLinkRelations.HELP
Refers to context-sensitive help.static final LinkRelation
IanaLinkRelations.HOSTS
Refers to a resource hosted by the server indicated by the link context.static final LinkRelation
IanaLinkRelations.HUB
Refers to a hub that enables registration for notification of updates to the context.static final LinkRelation
IanaLinkRelations.ICON
Refers to an icon representing the link's context.static final LinkRelation
IanaLinkRelations.INDEX
Refers to an index.static final LinkRelation
IanaLinkRelations.INTERVAL_AFTER
refers to a resource associated with a time interval that ends before the beginning of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_BEFORE
refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_CONTAINS
refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_DISJOINT
refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource, or ends before the beginning of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_DURING
refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_EQUALS
refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_FINISHED_BY
refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_FINISHES
refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_IN
refers to a resource associated with a time interval that begins before or is coincident with the beginning of the time interval associated with the context resource, and ends after or is coincident with the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_MEETS
refers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_MET_BY
refers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_OVERLAPPED_BY
refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the beginning of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_OVERLAPS
refers to a resource associated with a time interval that begins before the end of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_STARTED_BY
refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.INTERVAL_STARTS
refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resourcestatic final LinkRelation
IanaLinkRelations.ITEM
The target IRI points to a resource that is a member of the collection represented by the context IRI.static final LinkRelation
IanaLinkRelations.LAST
An IRI that refers to the furthest following resource in a series of resources.static final LinkRelation
IanaLinkRelations.LATEST_VERSION
Points to a resource containing the latest (e.g., current) version of the context.static final LinkRelation
IanaLinkRelations.LICENSE
Refers to a license associated with this context.static final LinkRelation
IanaLinkRelations.LRDD
Refers to further information about the link's context, expressed as a LRDD ("Link-based Resource Descriptor Document") resource.static final LinkRelation
IanaLinkRelations.MEMENTO
The Target IRI points to a Memento, a fixed resource that will not change state anymore.static final LinkRelation
IanaLinkRelations.MONITOR
Refers to a resource that can be used to monitor changes in an HTTP resource.static final LinkRelation
IanaLinkRelations.MONITOR_GROUP
Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.static final LinkRelation
IanaLinkRelations.NEXT
Indicates that the link's context is a part of a series, and that the next in the series is the link target.static final LinkRelation
IanaLinkRelations.NEXT_ARCHIVE
Refers to the immediately following archive resource.static final LinkRelation
IanaLinkRelations.NOFOLLOW
Indicates that the context’s original author or publisher does not endorse the link target.static final LinkRelation
IanaLinkRelations.NOREFERRER
Indicates that no referrer information is to be leaked when following the link.static final LinkRelation
IanaLinkRelations.ORIGINAL
The Target IRI points to an Original Resource.static final LinkRelation
IanaLinkRelations.PAYMENT
Indicates a resource where payment is accepted.static final LinkRelation
IanaLinkRelations.PINGBACK
Gives the address of the pingback resource for the link context.static final LinkRelation
IanaLinkRelations.PRECONNECT
Used to indicate an origin that will be used to fetch required resources for the link context.static final LinkRelation
IanaLinkRelations.PREDECESSOR_VERSION
Points to a resource containing the predecessor version in the version history.static final LinkRelation
IanaLinkRelations.PREFETCH
The prefetch link relation type is used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch, such that the user agent can deliver a faster response once the resource is requested in the future.static final LinkRelation
IanaLinkRelations.PRELOAD
Refers to a resource that should be loaded early in the processing of the link's context, without blocking rendering.static final LinkRelation
IanaLinkRelations.PRERENDER
Used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch and execute, such that the user agent can deliver a faster response once the resource is requested in the future.static final LinkRelation
IanaLinkRelations.PREV
Indicates that the link's context is a part of a series, and that the previous in the series is the link target.static final LinkRelation
IanaLinkRelations.PREV_ARCHIVE
Refers to the immediately preceding archive resource.static final LinkRelation
IanaLinkRelations.PREVIEW
Refers to a resource that provides a preview of the link's context.static final LinkRelation
IanaLinkRelations.PREVIOUS
Refers to the previous resource in an ordered series of resources.static final LinkRelation
IanaLinkRelations.PRIVACY_POLICY
Refers to a privacy policy associated with the link's context.static final LinkRelation
IanaLinkRelations.PROFILE
Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation.static final LinkRelation
IanaLinkRelations.RELATED
Identifies a related resource.static final LinkRelation
IanaLinkRelations.REPLIES
Identifies a resource that is a reply to the context of the link.static final LinkRelation
IanaLinkRelations.RESTCONF
Identifies the root of RESTCONF API as configured on this HTTP server.static final LinkRelation
IanaLinkRelations.SEARCH
Refers to a resource that can be used to search through the link's context and related resources.static final LinkRelation
IanaLinkRelations.SECTION
Refers to a section in a collection of resources.static final LinkRelation
IanaLinkRelations.SELF
Conveys an identifier for the link's context.static final LinkRelation
IanaLinkRelations.SERVICE
Indicates a URI that can be used to retrieve a service document.static final LinkRelation
IanaLinkRelations.START
Refers to the first resource in a collection of resources.static final LinkRelation
IanaLinkRelations.STYLESHEET
Refers to a stylesheet.static final LinkRelation
IanaLinkRelations.SUBSECTION
Refers to a resource serving as a subsection in a collection of resources.static final LinkRelation
IanaLinkRelations.SUCCESSOR_VERSION
Points to a resource containing the successor version in the version history.static final LinkRelation
IanaLinkRelations.TAG
Gives a tag (identified by the given address) that applies to the current document.static final LinkRelation
IanaLinkRelations.TERMS_OF_SERVICE
Refers to the terms of service associated with the link's context.static final LinkRelation
IanaLinkRelations.TIMEGATE
The Target IRI points to a TimeGate for an Original Resource.static final LinkRelation
IanaLinkRelations.TIMEMAP
The Target IRI points to a TimeMap for an Original Resource.static final LinkRelation
IanaLinkRelations.TYPE
Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.static final LinkRelation
IanaLinkRelations.UP
Refers to a parent document in a hierarchy of documents.static final LinkRelation
IanaLinkRelations.VERSION_HISTORY
Points to a resource containing the version history for the context.static final LinkRelation
IanaLinkRelations.VIA
Identifies a resource that is the source of the information in the link's context.static final LinkRelation
IanaLinkRelations.WEBMENTION
Identifies a target URI that supports the Webmention protcol.static final LinkRelation
IanaLinkRelations.WORKING_COPY
Points to a working copy for this resource.static final LinkRelation
IanaLinkRelations.WORKING_COPY_OF
Points to the versioned resource from which this working copy was obtained.Modifier and TypeMethodDescriptionLink.getRel()
default LinkRelation
Returns a newLinkRelation
with its relation mapped by the given function, unless it is an IANA one.static LinkRelation
Creates a newLinkRelation
.static LinkRelation
Convert a string-based link relation to aIanaLinkRelations
.Modifier and TypeMethodDescriptionLinks.getLink
(LinkRelation rel) Returns theLink
with the given rel.RepresentationModel.getLink
(LinkRelation relation) Returns the link with the givenLinkRelation
.RepresentationModel.getLinks
(LinkRelation relation) Returns allLink
s with the given relation.Links.getRequiredLink
(LinkRelation relation) Returns theLink
with the given relation.RepresentationModel.getRequiredLink
(LinkRelation relation) Returns the link with the given relation.boolean
Links.hasLink
(LinkRelation relation) boolean
RepresentationModel.hasLink
(LinkRelation rel) boolean
Link.hasRel
(LinkRelation rel) Returns whether theLink
has the givenLinkRelation
.static boolean
IanaLinkRelations.isIanaRel
(LinkRelation relation) Is this relation an IANA standard?default boolean
LinkRelation.isSameAs
(LinkRelation relation) Returns whether the givenLinkRelation
is logically the same as the current one, independent of implementation, i.e. whether the plainString
values match.RepresentationModel.mapLink
(LinkRelation relation, Function<Link, Link> mapper) Replaces the link(s) with the givenLinkRelation
with the mapper applied to each of the links.RepresentationModel.mapLinkIf
(boolean condition, LinkRelation relation, Function<Link, Link> mapper) Replaces the link(s) with the givenLinkRelation
with the mapper applied to each of the links if the given condition is true.static Link
Link.of
(String href, LinkRelation relation) Creates a newLink
to the given href andLinkRelation
.static Link
Link.of
(UriTemplate template, LinkRelation relation) Links.without
(LinkRelation relation) Link.withRel
(LinkRelation relation) Creates a newLink
with the same href but givenLinkRelation
.ModifierConstructorDescriptionprotected
Link
(String href, LinkRelation rel) Creates a newLink
to the given URI with the given rel.protected
Link
(UriTemplate template, LinkRelation rel) Creates a new Link from the givenUriTemplate
and rel. -
Uses of LinkRelation in org.springframework.hateoas.client
Modifier and TypeMethodDescriptionprotected Link
JsonPathLinkDiscoverer.extractLink
(Object element, LinkRelation rel) Callback for eachLinkDiscoverer
to extract relevant attributes and generate aLink
.JsonPathLinkDiscoverer.findLinksWithRel
(LinkRelation relation, InputStream representation) JsonPathLinkDiscoverer.findLinksWithRel
(LinkRelation relation, String representation) LinkDiscoverer.findLinksWithRel
(LinkRelation relation, InputStream representation) Returns all links with the givenLinkRelation
found in the givenInputStream
representation.LinkDiscoverer.findLinksWithRel
(LinkRelation relation, String representation) Returns all links with the givenLinkRelation
found in the givenString
representation.JsonPathLinkDiscoverer.findLinkWithRel
(LinkRelation relation, InputStream representation) JsonPathLinkDiscoverer.findLinkWithRel
(LinkRelation relation, String representation) LinkDiscoverer.findLinkWithRel
(LinkRelation relation, InputStream representation) Finds a single link with the givenLinkRelation
in the givenInputStream
representation.LinkDiscoverer.findLinkWithRel
(LinkRelation relation, String representation) Finds a single link with the givenLinkRelation
in the givenString
representation.default Link
LinkDiscoverer.findRequiredLinkWithRel
(LinkRelation relation, InputStream representation) Finds a single link with the given relation type in the givenInputStream
representation.default Link
LinkDiscoverer.findRequiredLinkWithRel
(LinkRelation relation, String representation) Finds a single link with the given relation in the givenString
representation. -
Uses of LinkRelation in org.springframework.hateoas.mediatype.collectionjson
Modifier and TypeMethodDescriptionCollectionJsonLinkDiscoverer.findLinksWithRel
(LinkRelation relation, InputStream representation) CollectionJsonLinkDiscoverer.findLinksWithRel
(LinkRelation relation, String representation) CollectionJsonLinkDiscoverer.findLinkWithRel
(LinkRelation relation, InputStream representation) CollectionJsonLinkDiscoverer.findLinkWithRel
(LinkRelation relation, String representation) -
Uses of LinkRelation in org.springframework.hateoas.mediatype.hal
Modifier and TypeClassDescriptionclass
Value object for HAL basedLinkRelation
, i.e. a relation that can be curied.Modifier and TypeMethodDescriptionHalModelBuilder.embed
(Object entity, LinkRelation linkRelation) Embed the entity and associate it with theLinkRelation
.HalModelBuilder.embed
(Collection<?> collection, LinkRelation relation) Embeds the given collection in theRepresentationModel
for the givenLinkRelation
.HalModelBuilder.embed
(Stream<?> stream, LinkRelation relation) protected Link
HalLinkDiscoverer.extractLink
(Object element, LinkRelation rel) default HalModelBuilder
HalModelBuilder.PreviewBuilder.forLink
(String href, LinkRelation relation) Concludes the set up of a preview for theLink
consisting ot the given href andLinkRelation
.CurieProvider.getNamespacedRelFor
(LinkRelation rel) Returns the rel to be rendered for the given rel.DefaultCurieProvider.getNamespacedRelFor
(LinkRelation relation) HalModelBuilder.link
(String href, LinkRelation relation) Jackson2HalModule.EmbeddedMapper.map
(LinkRelation source) Maps the givenHalLinkRelation
using the underlying relation transformer.static HalLinkRelation
HalLinkRelation.of
(LinkRelation relation) Returns aHalLinkRelation
for the given generalLinkRelation
.HalConfiguration.withRenderSingleLinksFor
(LinkRelation relation, HalConfiguration.RenderSingleLinks renderSingleLinks) Configures how to render a single link for a given particularLinkRelation
. -
Uses of LinkRelation in org.springframework.hateoas.mediatype.uber
Modifier and TypeMethodDescriptionUberLinkDiscoverer.findLinksWithRel
(LinkRelation rel, InputStream representation) UberLinkDiscoverer.findLinksWithRel
(LinkRelation rel, String representation) UberLinkDiscoverer.findLinkWithRel
(LinkRelation rel, InputStream representation) UberLinkDiscoverer.findLinkWithRel
(LinkRelation rel, String representation) -
Uses of LinkRelation in org.springframework.hateoas.server
Modifier and TypeMethodDescriptionLinkRelationProvider.getCollectionResourceRelFor
(Class<?> type) Returns the relation type to be used to point to a collection resource of the given type.LinkRelationProvider.getItemResourceRelFor
(Class<?> type) Returns the relation type to be used to point to an item resource of the given type.Modifier and TypeMethodDescriptionLinkBuilder.withRel
(LinkRelation rel) Creates theLink
built by the current builder instance with the givenLinkRelation
. -
Uses of LinkRelation in org.springframework.hateoas.server.core
Modifier and TypeMethodDescriptionAnnotationLinkRelationProvider.getCollectionResourceRelFor
(Class<?> type) DefaultLinkRelationProvider.getCollectionResourceRelFor
(Class<?> type) DelegatingLinkRelationProvider.getCollectionResourceRelFor
(Class<?> type) EvoInflectorLinkRelationProvider.getCollectionResourceRelFor
(Class<?> type) AnnotationLinkRelationProvider.getItemResourceRelFor
(Class<?> type) DefaultLinkRelationProvider.getItemResourceRelFor
(Class<?> type) DelegatingLinkRelationProvider.getItemResourceRelFor
(Class<?> type) Modifier and TypeMethodDescriptionEmbeddedWrapper.getRel()
Returns the rel to be used when embedding.Modifier and TypeMethodDescriptionboolean
EmbeddedWrapper.hasRel
(LinkRelation rel) Returns whether the wrapper has the given rel.LinkBuilderSupport.withRel
(LinkRelation rel) EmbeddedWrappers.wrap
(Object source, LinkRelation rel) Creates a newEmbeddedWrapper
with the given rel. -
Uses of LinkRelation in org.springframework.hateoas.server.mvc
Modifier and TypeMethodDescriptionControllerLinkRelationProvider.getCollectionResourceRelFor
(Class<?> resource) ControllerLinkRelationProvider.getItemResourceRelFor
(Class<?> resource) Modifier and TypeMethodDescriptionstatic Link
MvcLink.of
(Object invocation, LinkRelation relation) Creates a newLink
from the givenMvcUriComponentsBuilder
invocation.static Link
MvcLink.of
(Supplier<Object> invocation, LinkRelation relation) Creates a newLink
from the given lazyMvcUriComponentsBuilder
invocation. -
Uses of LinkRelation in org.springframework.hateoas.server.reactive
Modifier and TypeMethodDescriptionWebFluxLinkBuilder.WebFluxBuilder.withRel
(LinkRelation relation)