Uses of Interface
org.springframework.hateoas.LinkRelation
Packages that use LinkRelation
Package
Description
Value objects to ease creating
Links 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
Links and assemble
RepresentationModel types.Spring WebFlux components to build
Links and assemble
RepresentationModel types.-
Uses of LinkRelation in org.springframework.hateoas
Fields in org.springframework.hateoas declared as LinkRelationModifier and TypeFieldDescriptionstatic final LinkRelationIanaLinkRelations.ABOUTRefers to a resource that is the subject of the link's context.static final LinkRelationIanaLinkRelations.ALTERNATERefers to a substitute for this contextstatic final LinkRelationIanaLinkRelations.APPENDIXRefers to an appendix.static final LinkRelationIanaLinkRelations.ARCHIVESRefers to a collection of records, documents, or other materials of historical interest.static final LinkRelationIanaLinkRelations.AUTHORRefers to the context's author.static final LinkRelationIanaLinkRelations.BLOCKED_BYIdentifies the entity that blocks access to a resource following receipt of a legal demand.static final LinkRelationIanaLinkRelations.BOOKMARKGives a permanent link to use for bookmarking purposes.static final LinkRelationIanaLinkRelations.CANONICALDesignates the preferred version of a resource (the IRI and its contents).static final LinkRelationIanaLinkRelations.CHAPTERRefers to a chapter in a collection of resources.static final LinkRelationIanaLinkRelations.CITE_ASIndicates that the link target is preferred over the link context for the purpose of referencing.static final LinkRelationIanaLinkRelations.COLLECTIONThe target IRI points to a resource which represents the collection resource for the context IRI.static final LinkRelationIanaLinkRelations.CONTENTSRefers to a table of contents.static final LinkRelationIanaLinkRelations.CONVERTED_FROMThe document linked to was later converted to the document that contains this link relation.static final LinkRelationIanaLinkRelations.COPYRIGHTRefers to a copyright statement that applies to the link's context.static final LinkRelationIanaLinkRelations.CREATE_FORMThe target IRI points to a resource where a submission form can be obtained.static final LinkRelationIanaLinkRelations.CURRENTRefers to a resource containing the most recent item(s) in a collection of resources.static final LinkRelationIanaLinkRelations.DESCRIBED_BYRefers to a resource providing information about the link's context.static final LinkRelationIanaLinkRelations.DESCRIBESThe relationship A 'describes' B asserts that resource A provides a description of resource B.static final LinkRelationIanaLinkRelations.DISCLOSURERefers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified.static final LinkRelationIanaLinkRelations.DNS_PREFETCHUsed 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 LinkRelationIanaLinkRelations.DUPLICATERefers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI.static final LinkRelationIanaLinkRelations.EDITRefers to a resource that can be used to edit the link's context.static final LinkRelationIanaLinkRelations.EDIT_FORMThe target IRI points to a resource where a submission form for editing associated resource can be obtained.static final LinkRelationIanaLinkRelations.EDIT_MEDIARefers to a resource that can be used to edit media associated with the link's context.static final LinkRelationIanaLinkRelations.ENCLOSUREIdentifies a related resource that is potentially large and might require special handling.static final LinkRelationIanaLinkRelations.FIRSTAn IRI that refers to the furthest preceding resource in a series of resources.static final LinkRelationIanaLinkRelations.GLOSSARYRefers to a glossary of terms.static final LinkRelationIanaLinkRelations.HELPRefers to context-sensitive help.static final LinkRelationIanaLinkRelations.HOSTSRefers to a resource hosted by the server indicated by the link context.static final LinkRelationIanaLinkRelations.HUBRefers to a hub that enables registration for notification of updates to the context.static final LinkRelationIanaLinkRelations.ICONRefers to an icon representing the link's context.static final LinkRelationIanaLinkRelations.INDEXRefers to an index.static final LinkRelationIanaLinkRelations.INTERVAL_AFTERrefers to a resource associated with a time interval that ends before the beginning of the time interval associated with the context resourcestatic final LinkRelationIanaLinkRelations.INTERVAL_BEFORErefers to a resource associated with a time interval that begins after the end of the time interval associated with the context resourcestatic final LinkRelationIanaLinkRelations.INTERVAL_CONTAINSrefers 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 LinkRelationIanaLinkRelations.INTERVAL_DISJOINTrefers 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 LinkRelationIanaLinkRelations.INTERVAL_DURINGrefers 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 LinkRelationIanaLinkRelations.INTERVAL_EQUALSrefers 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 LinkRelationIanaLinkRelations.INTERVAL_FINISHED_BYrefers 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 LinkRelationIanaLinkRelations.INTERVAL_FINISHESrefers 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 LinkRelationIanaLinkRelations.INTERVAL_INrefers 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 LinkRelationIanaLinkRelations.INTERVAL_MEETSrefers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resourcestatic final LinkRelationIanaLinkRelations.INTERVAL_MET_BYrefers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resourcestatic final LinkRelationIanaLinkRelations.INTERVAL_OVERLAPPED_BYrefers 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 LinkRelationIanaLinkRelations.INTERVAL_OVERLAPSrefers 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 LinkRelationIanaLinkRelations.INTERVAL_STARTED_BYrefers 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 LinkRelationIanaLinkRelations.INTERVAL_STARTSrefers 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 LinkRelationIanaLinkRelations.ITEMThe target IRI points to a resource that is a member of the collection represented by the context IRI.static final LinkRelationIanaLinkRelations.LASTAn IRI that refers to the furthest following resource in a series of resources.static final LinkRelationIanaLinkRelations.LATEST_VERSIONPoints to a resource containing the latest (e.g., current) version of the context.static final LinkRelationIanaLinkRelations.LICENSERefers to a license associated with this context.static final LinkRelationIanaLinkRelations.LRDDRefers to further information about the link's context, expressed as a LRDD ("Link-based Resource Descriptor Document") resource.static final LinkRelationIanaLinkRelations.MEMENTOThe Target IRI points to a Memento, a fixed resource that will not change state anymore.static final LinkRelationIanaLinkRelations.MONITORRefers to a resource that can be used to monitor changes in an HTTP resource.static final LinkRelationIanaLinkRelations.MONITOR_GROUPRefers to a resource that can be used to monitor changes in a specified group of HTTP resources.static final LinkRelationIanaLinkRelations.NEXTIndicates that the link's context is a part of a series, and that the next in the series is the link target.static final LinkRelationIanaLinkRelations.NEXT_ARCHIVERefers to the immediately following archive resource.static final LinkRelationIanaLinkRelations.NOFOLLOWIndicates that the context’s original author or publisher does not endorse the link target.static final LinkRelationIanaLinkRelations.NOREFERRERIndicates that no referrer information is to be leaked when following the link.static final LinkRelationIanaLinkRelations.ORIGINALThe Target IRI points to an Original Resource.static final LinkRelationIanaLinkRelations.PAYMENTIndicates a resource where payment is accepted.static final LinkRelationIanaLinkRelations.PINGBACKGives the address of the pingback resource for the link context.static final LinkRelationIanaLinkRelations.PRECONNECTUsed to indicate an origin that will be used to fetch required resources for the link context.static final LinkRelationIanaLinkRelations.PREDECESSOR_VERSIONPoints to a resource containing the predecessor version in the version history.static final LinkRelationIanaLinkRelations.PREFETCHThe 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 LinkRelationIanaLinkRelations.PRELOADRefers to a resource that should be loaded early in the processing of the link's context, without blocking rendering.static final LinkRelationIanaLinkRelations.PRERENDERUsed 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 LinkRelationIanaLinkRelations.PREVIndicates that the link's context is a part of a series, and that the previous in the series is the link target.static final LinkRelationIanaLinkRelations.PREV_ARCHIVERefers to the immediately preceding archive resource.static final LinkRelationIanaLinkRelations.PREVIEWRefers to a resource that provides a preview of the link's context.static final LinkRelationIanaLinkRelations.PREVIOUSRefers to the previous resource in an ordered series of resources.static final LinkRelationIanaLinkRelations.PRIVACY_POLICYRefers to a privacy policy associated with the link's context.static final LinkRelationIanaLinkRelations.PROFILEIdentifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation.static final LinkRelationIanaLinkRelations.RELATEDIdentifies a related resource.static final LinkRelationIanaLinkRelations.REPLIESIdentifies a resource that is a reply to the context of the link.static final LinkRelationIanaLinkRelations.RESTCONFIdentifies the root of RESTCONF API as configured on this HTTP server.static final LinkRelationIanaLinkRelations.SEARCHRefers to a resource that can be used to search through the link's context and related resources.static final LinkRelationIanaLinkRelations.SECTIONRefers to a section in a collection of resources.static final LinkRelationIanaLinkRelations.SELFConveys an identifier for the link's context.static final LinkRelationIanaLinkRelations.SERVICEIndicates a URI that can be used to retrieve a service document.static final LinkRelationIanaLinkRelations.STARTRefers to the first resource in a collection of resources.static final LinkRelationIanaLinkRelations.STYLESHEETRefers to a stylesheet.static final LinkRelationIanaLinkRelations.SUBSECTIONRefers to a resource serving as a subsection in a collection of resources.static final LinkRelationIanaLinkRelations.SUCCESSOR_VERSIONPoints to a resource containing the successor version in the version history.static final LinkRelationIanaLinkRelations.TAGGives a tag (identified by the given address) that applies to the current document.static final LinkRelationIanaLinkRelations.TERMS_OF_SERVICERefers to the terms of service associated with the link's context.static final LinkRelationIanaLinkRelations.TIMEGATEThe Target IRI points to a TimeGate for an Original Resource.static final LinkRelationIanaLinkRelations.TIMEMAPThe Target IRI points to a TimeMap for an Original Resource.static final LinkRelationIanaLinkRelations.TYPERefers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.static final LinkRelationIanaLinkRelations.UPRefers to a parent document in a hierarchy of documents.static final LinkRelationIanaLinkRelations.VERSION_HISTORYPoints to a resource containing the version history for the context.static final LinkRelationIanaLinkRelations.VIAIdentifies a resource that is the source of the information in the link's context.static final LinkRelationIanaLinkRelations.WEBMENTIONIdentifies a target URI that supports the Webmention protcol.static final LinkRelationIanaLinkRelations.WORKING_COPYPoints to a working copy for this resource.static final LinkRelationIanaLinkRelations.WORKING_COPY_OFPoints to the versioned resource from which this working copy was obtained.Methods in org.springframework.hateoas that return LinkRelationModifier and TypeMethodDescriptionLink.getRel()default LinkRelationReturns a newLinkRelationwith its relation mapped by the given function, unless it is an IANA one.static LinkRelationCreates a newLinkRelation.static LinkRelationConvert a string-based link relation to aIanaLinkRelations.Methods in org.springframework.hateoas that return types with arguments of type LinkRelationMethods in org.springframework.hateoas with parameters of type LinkRelationModifier and TypeMethodDescriptionLinks.getLink(LinkRelation rel) Returns theLinkwith the given rel.RepresentationModel.getLink(LinkRelation relation) Returns the link with the givenLinkRelation.RepresentationModel.getLinks(LinkRelation relation) Returns allLinks with the given relation.Links.getRequiredLink(LinkRelation relation) Returns theLinkwith the given relation.RepresentationModel.getRequiredLink(LinkRelation relation) Returns the link with the given relation.booleanLinks.hasLink(LinkRelation relation) booleanRepresentationModel.hasLink(LinkRelation rel) booleanLink.hasRel(LinkRelation rel) Returns whether theLinkhas the givenLinkRelation.static booleanIanaLinkRelations.isIanaRel(LinkRelation relation) Is this relation an IANA standard?default booleanLinkRelation.isSameAs(LinkRelation relation) Returns whether the givenLinkRelationis logically the same as the current one, independent of implementation, i.e. whether the plainStringvalues match.RepresentationModel.mapLink(LinkRelation relation, Function<Link, Link> mapper) Replaces the link(s) with the givenLinkRelationwith the mapper applied to each of the links.RepresentationModel.mapLinkIf(boolean condition, LinkRelation relation, Function<Link, Link> mapper) Replaces the link(s) with the givenLinkRelationwith the mapper applied to each of the links if the given condition is true.static LinkLink.of(String href, LinkRelation relation) Creates a newLinkto the given href andLinkRelation.static LinkLink.of(UriTemplate template, LinkRelation relation) Links.without(LinkRelation relation) Link.withRel(LinkRelation relation) Creates a newLinkwith the same href but givenLinkRelation.Constructors in org.springframework.hateoas with parameters of type LinkRelationModifierConstructorDescriptionprotectedLink(String href, LinkRelation rel) Creates a newLinkto the given URI with the given rel.protectedLink(UriTemplate template, LinkRelation rel) Creates a new Link from the givenUriTemplateand rel. -
Uses of LinkRelation in org.springframework.hateoas.client
Methods in org.springframework.hateoas.client with parameters of type LinkRelationModifier and TypeMethodDescriptionprotected LinkJsonPathLinkDiscoverer.extractLink(Object element, LinkRelation rel) Callback for eachLinkDiscovererto 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 givenLinkRelationfound in the givenInputStreamrepresentation.LinkDiscoverer.findLinksWithRel(LinkRelation relation, String representation) Returns all links with the givenLinkRelationfound in the givenStringrepresentation.JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStream representation) JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation, String representation) LinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStream representation) Finds a single link with the givenLinkRelationin the givenInputStreamrepresentation.LinkDiscoverer.findLinkWithRel(LinkRelation relation, String representation) Finds a single link with the givenLinkRelationin the givenStringrepresentation.default LinkLinkDiscoverer.findRequiredLinkWithRel(LinkRelation relation, InputStream representation) Finds a single link with the given relation type in the givenInputStreamrepresentation.default LinkLinkDiscoverer.findRequiredLinkWithRel(LinkRelation relation, String representation) Finds a single link with the given relation in the givenStringrepresentation. -
Uses of LinkRelation in org.springframework.hateoas.mediatype.collectionjson
Methods in org.springframework.hateoas.mediatype.collectionjson with parameters of type LinkRelationModifier 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
Classes in org.springframework.hateoas.mediatype.hal that implement LinkRelationModifier and TypeClassDescriptionclassValue object for HAL basedLinkRelation, i.e. a relation that can be curied.Methods in org.springframework.hateoas.mediatype.hal with parameters of type LinkRelationModifier 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 theRepresentationModelfor the givenLinkRelation.HalModelBuilder.embed(Stream<?> stream, LinkRelation relation) protected LinkHalLinkDiscoverer.extractLink(Object element, LinkRelation rel) default HalModelBuilderHalModelBuilder.PreviewBuilder.forLink(String href, LinkRelation relation) Concludes the set up of a preview for theLinkconsisting 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) HalJacksonModule.EmbeddedMapper.map(LinkRelation source) Maps the givenHalLinkRelationusing the underlying relation transformer.static HalLinkRelationHalLinkRelation.of(LinkRelation relation) Returns aHalLinkRelationfor 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
Methods in org.springframework.hateoas.mediatype.uber with parameters of type LinkRelationModifier 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
Methods in org.springframework.hateoas.server that return LinkRelationModifier 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.Methods in org.springframework.hateoas.server with parameters of type LinkRelationModifier and TypeMethodDescriptionLinkBuilder.withRel(LinkRelation rel) Creates theLinkbuilt by the current builder instance with the givenLinkRelation. -
Uses of LinkRelation in org.springframework.hateoas.server.core
Methods in org.springframework.hateoas.server.core that return LinkRelationModifier 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) Methods in org.springframework.hateoas.server.core that return types with arguments of type LinkRelationModifier and TypeMethodDescriptionEmbeddedWrapper.getRel()Returns the rel to be used when embedding.Methods in org.springframework.hateoas.server.core with parameters of type LinkRelationModifier and TypeMethodDescriptionbooleanEmbeddedWrapper.hasRel(LinkRelation rel) Returns whether the wrapper has the given rel.LinkBuilderSupport.withRel(LinkRelation rel) EmbeddedWrappers.wrap(Object source, LinkRelation rel) Creates a newEmbeddedWrapperwith the given rel. -
Uses of LinkRelation in org.springframework.hateoas.server.mvc
Methods in org.springframework.hateoas.server.mvc that return LinkRelationModifier and TypeMethodDescriptionControllerLinkRelationProvider.getCollectionResourceRelFor(Class<?> resource) ControllerLinkRelationProvider.getItemResourceRelFor(Class<?> resource) Methods in org.springframework.hateoas.server.mvc with parameters of type LinkRelationModifier and TypeMethodDescriptionstatic LinkMvcLink.of(Object invocation, LinkRelation relation) Creates a newLinkfrom the givenMvcUriComponentsBuilderinvocation.static LinkMvcLink.of(Supplier<Object> invocation, LinkRelation relation) Creates a newLinkfrom the given lazyMvcUriComponentsBuilderinvocation. -
Uses of LinkRelation in org.springframework.hateoas.server.reactive
Methods in org.springframework.hateoas.server.reactive with parameters of type LinkRelationModifier and TypeMethodDescriptionWebFluxLinkBuilder.WebFluxBuilder.withRel(LinkRelation relation)