Package | Description |
---|---|
org.springframework.hateoas |
Value objects to ease creating
Link s and link driven representations for REST
webservices. |
org.springframework.hateoas.client |
Client side support.
|
org.springframework.hateoas.mediatype |
Spring container configuration support.
|
org.springframework.hateoas.mediatype.collectionjson |
Value objects to build Collection+JSON representations.
|
org.springframework.hateoas.mediatype.hal |
HAL-specific extensions, SPIs and Jackson customizations.
|
org.springframework.hateoas.mediatype.uber |
UBER media type objects.
|
org.springframework.hateoas.mediatype.vnderrors |
Vnd.Error media type.
|
org.springframework.hateoas.server |
Server-side components for hypermedia handling.
|
org.springframework.hateoas.server.core |
Implementations of core API interfaces.
|
org.springframework.hateoas.server.mvc |
Spring MVC helper classes to build
Link s and assemble
RepresentationModel types. |
org.springframework.hateoas.server.reactive |
Spring WebFlux components to build
Link s and assemble
RepresentationModel types. |
Modifier and Type | Method and Description |
---|---|
Link |
Link.andAffordance(Affordance affordance)
Create new
Link with an additional Affordance . |
Link |
Link.andAffordances(List<Affordance> affordances)
Create new
Link with additional Affordance s. |
Link |
Link.expand(Map<String,?> arguments)
Turns the current template into a
Link by expanding it using the given parameters. |
Link |
Link.expand(Object... arguments)
Turns the current template into a
Link by expanding it using the given parameters. |
Link |
AffordanceModel.getLink() |
Link |
RepresentationModel.getRequiredLink(LinkRelation relation)
Returns the link with the given relation.
|
Link |
Links.getRequiredLink(LinkRelation relation)
Returns the
Link with the given relation. |
Link |
RepresentationModel.getRequiredLink(String relation)
Returns the link with the given relation.
|
Link |
Links.getRequiredLink(String rel)
Returns the
Link with the given relation. |
static Link |
Link.of(String href)
Creates a new link to the given URI with the self relation.
|
static Link |
Link.of(String href,
LinkRelation relation)
Creates a new
Link to the given href and LinkRelation . |
static Link |
Link.of(String href,
String relation)
Creates a new
Link to the given href with the given relation. |
static Link |
Link.of(UriTemplate template,
LinkRelation relation)
|
static Link |
Link.of(UriTemplate template,
String relation)
Creates a new
Link to the given UriTemplate and link relation. |
static Link |
Link.valueOf(String element)
|
Link |
Link.withAffordances(List<Affordance> affordances)
Creats a new
Link with the given Affordance s. |
Link |
Link.withDeprecation(String deprecation)
Create a new
Link by copying all attributes and applying the new deprecation. |
Link |
Link.withHref(String href)
Create a new
Link by copying all attributes and applying the new href. |
Link |
Link.withHreflang(String hreflang)
Create a new
Link by copying all attributes and applying the new hrefleng. |
Link |
Link.withMedia(String media)
Create a new
Link by copying all attributes and applying the new media. |
Link |
Link.withName(String name)
Create a new
Link by copying all attributes and applying the new name. |
Link |
Link.withProfile(String profile)
Create a new
Link by copying all attributes and applying the new profile. |
Link |
Link.withRel(LinkRelation relation)
Creates a new
Link with the same href but given LinkRelation . |
Link |
Link.withRel(String relation)
Creates a new
Link with the same href but given LinkRelation . |
Link |
Link.withSelfRel()
Returns a
Link pointing to the same URI but with the self relation. |
Link |
Link.withTitle(String title)
Create a new
Link by copying all attributes and applying the new title. |
Link |
Link.withType(String type)
Create a new
Link by copying all attributes and applying the new type. |
Modifier and Type | Method and Description |
---|---|
static Collector<Link,?,Links> |
Links.collector()
|
Optional<Link> |
RepresentationModel.getLink(LinkRelation relation)
Returns the link with the given
LinkRelation . |
Optional<Link> |
Links.getLink(LinkRelation rel)
Returns the
Link with the given rel. |
Optional<Link> |
RepresentationModel.getLink(String relation)
Returns the link with the given relation.
|
Optional<Link> |
Links.getLink(String relation)
Returns a
Link with the given relation if contained in the current Links instance,
Optional.empty() otherwise. |
List<Link> |
RepresentationModel.getLinks(LinkRelation relation)
Returns all
Link s with the given relation. |
List<Link> |
RepresentationModel.getLinks(String relation)
Returns all
Link s with the given relation. |
Optional<Link> |
PagedModel.getNextLink()
Returns the Link pointing to the next page (if set).
|
Optional<Link> |
PagedModel.getPreviousLink()
Returns the Link pointing to the previous page (if set).
|
Iterator<Link> |
Links.iterator() |
Stream<Link> |
Links.stream()
|
List<Link> |
Links.toList()
|
Modifier and Type | Method and Description |
---|---|
T |
RepresentationModel.add(Link... links)
Adds all given
Link s to the resource. |
T |
RepresentationModel.add(Link link)
Adds the given link to the resource.
|
Links |
Links.and(Link... links)
|
Links |
Links.andIf(boolean condition,
Link... links)
Adds the given links if the given condition is true.
|
boolean |
Links.contains(Link... links)
|
static <T> CollectionModel<T> |
CollectionModel.empty(Link... links)
Creates a new empty collection model with the given links.
|
static <T> PagedModel<T> |
PagedModel.empty(Link... links)
Creates an empty
PagedModel with the given links. |
static <T> PagedModel<T> |
PagedModel.empty(PagedModel.PageMetadata metadata,
Link... links)
Creates an empty
PagedModel with the given PagedModel.PageMetadata and links. |
Links |
Links.merge(Link... links)
|
Links |
Links.merge(Links.MergeMode mode,
Link... links)
Merges the current
Links with the given ones applying the given Links.MergeMode . |
static <T> PagedModel<T> |
PagedModel.of(Collection<T> content,
PagedModel.PageMetadata metadata,
Link... links)
|
static <T> CollectionModel<T> |
CollectionModel.of(Iterable<T> content,
Link... links)
Creates a
CollectionModel instance with the given content and Link s (optional). |
static Links |
Links.of(Link... links)
|
static <T> EntityModel<T> |
EntityModel.of(T content,
Link... links)
Creates a new
EntityModel with the given content and Link s (optional). |
boolean |
AffordanceModel.pointsToTargetOf(Link link)
Returns whether the
Affordance points to the target of the given Link . |
Modifier and Type | Method and Description |
---|---|
T |
RepresentationModel.add(Iterable<Link> links)
Adds all given
Link s to the resource. |
T |
RepresentationModel.addAllIf(boolean guard,
Supplier<? extends Iterable<Link>> links)
Adds all
Link s produced by the given Supplier if the guard is true. |
T |
RepresentationModel.addIf(boolean guard,
Supplier<Link> link)
Adds the
Link produced by the given Supplier if the guard is true. |
Links |
Links.and(Iterable<Link> links)
|
Links |
Links.and(Stream<Link> links)
|
Links |
Links.andIf(boolean condition,
Stream<Link> links)
Adds the given links if the given condition is true.
|
boolean |
Links.contains(Iterable<Link> links)
|
boolean |
Links.containsSameLinksAs(Iterable<Link> links)
|
static <T> CollectionModel<T> |
CollectionModel.empty(Iterable<Link> links)
Creates a new empty collection model with the given links.
|
static <T> PagedModel<T> |
PagedModel.empty(Iterable<Link> links)
Creates an empty
PagedModel with the given links. |
static <T> PagedModel<T> |
PagedModel.empty(PagedModel.PageMetadata metadata,
Iterable<Link> links)
Creates an empty
PagedModel with the given PagedModel.PageMetadata and links. |
Links |
Links.merge(Iterable<Link> links)
|
Links |
Links.merge(Links.MergeMode mode,
Iterable<Link> links)
Merges the current
Links with the given ones applying the given Links.MergeMode . |
Links |
Links.merge(Links.MergeMode mode,
Stream<Link> links)
Merges the current
Links with the given ones applying the given Links.MergeMode . |
Links |
Links.merge(Stream<Link> links)
|
static <T> PagedModel<T> |
PagedModel.of(Collection<T> content,
PagedModel.PageMetadata metadata,
Iterable<Link> links)
|
static Links |
Links.of(Iterable<Link> links)
|
static <T> CollectionModel<T> |
CollectionModel.of(Iterable<T> content,
Iterable<Link> links)
s Creates a
CollectionModel instance with the given content and Link s. |
static <T> RepresentationModel<?> |
RepresentationModel.of(T object,
Iterable<Link> links)
Creates a new
RepresentationModel for the given content object and links. |
static <T> EntityModel<T> |
EntityModel.of(T content,
Iterable<Link> links)
Creates a new
EntityModel with the given content and Link s. |
Constructor and Description |
---|
AffordanceModel(String name,
Link link,
HttpMethod httpMethod,
AffordanceModel.InputPayloadMetadata input,
List<QueryParameter> queryMethodParameters,
AffordanceModel.PayloadMetadata output) |
CollectionModel(Iterable<T> content,
Link... links)
Deprecated.
since 1.1, use
CollectionModel.of(Iterable, Link...) instead. |
EntityModel(T content,
Link... links)
Deprecated.
since 1.1, use
EntityModel.of(Object, Link...) instead. |
PagedModel(Collection<T> content,
PagedModel.PageMetadata metadata,
Link... links)
Deprecated.
|
RepresentationModel(Link initialLink) |
Constructor and Description |
---|
CollectionModel(Iterable<T> content,
Iterable<Link> links)
Deprecated.
since 1.1, use
CollectionModel.of(Iterable, Iterable) instead. |
EntityModel(T content,
Iterable<Link> links)
Deprecated.
since 1.1, use
EntityModel.of(Object, Iterable) instead. |
PagedModel(Collection<T> content,
PagedModel.PageMetadata metadata,
Iterable<Link> links)
Deprecated.
|
RepresentationModel(Iterable<Link> initialLinks) |
Modifier and Type | Method and Description |
---|---|
Link |
Traverson.TraversalBuilder.asLink()
Returns the
Link found for the last rel in the rels configured to follow. |
Link |
Traverson.TraversalBuilder.asTemplatedLink()
Returns the templated
Link found for the last relation in the rels configured to follow. |
protected Link |
JsonPathLinkDiscoverer.extractLink(Object element,
LinkRelation rel)
Callback for each
LinkDiscoverer to extract relevant attributes and generate a Link . |
default Link |
LinkDiscoverer.findRequiredLinkWithRel(LinkRelation relation,
InputStream representation)
Finds a single link with the given relation type in the given
InputStream representation. |
default Link |
LinkDiscoverer.findRequiredLinkWithRel(LinkRelation relation,
String representation)
Finds a single link with the given relation in the given
String representation. |
Modifier and Type | Method and Description |
---|---|
Optional<Link> |
JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation,
InputStream representation) |
Optional<Link> |
LinkDiscoverer.findLinkWithRel(LinkRelation relation,
InputStream representation)
Finds a single link with the given
LinkRelation in the given InputStream representation. |
Optional<Link> |
JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation,
String representation) |
Optional<Link> |
LinkDiscoverer.findLinkWithRel(LinkRelation relation,
String representation)
Finds a single link with the given
LinkRelation in the given String representation. |
default Optional<Link> |
LinkDiscoverer.findLinkWithRel(String relation,
InputStream representation)
Finds a single link with the given relation type in the given
InputStream representation. |
default Optional<Link> |
LinkDiscoverer.findLinkWithRel(String relation,
String representation)
Finds a single link with the given relation type in the given
String representation. |
Modifier and Type | Method and Description |
---|---|
Link |
Affordances.toLink() |
Link |
Affordances.AffordanceBuilder.toLink() |
Link |
AffordanceOperations.toLink()
Returns a
Link equipped with the Affordance currently under construction. |
Modifier and Type | Method and Description |
---|---|
AffordanceModel |
AffordanceModelFactory.getAffordanceModel(String name,
Link link,
HttpMethod httpMethod,
AffordanceModel.InputPayloadMetadata inputType,
List<QueryParameter> queryMethodParameters,
AffordanceModel.PayloadMetadata outputType)
Look up the
AffordanceModel for this factory. |
static Affordances |
Affordances.of(Link link) |
Affordances.AffordanceBuilder |
Affordances.AffordanceBuilder.withTarget(Link target)
Create a new
Affordances.AffordanceBuilder by copying all attributes and replacing the target. |
Modifier and Type | Method and Description |
---|---|
Optional<Link> |
CollectionJsonLinkDiscoverer.findLinkWithRel(LinkRelation relation,
InputStream representation) |
Optional<Link> |
CollectionJsonLinkDiscoverer.findLinkWithRel(LinkRelation relation,
String representation) |
Modifier and Type | Class and Description |
---|---|
protected static class |
DefaultCurieProvider.Curie
Value object to get the curie
Link rendered in JSON. |
class |
LinkMixin
Custom mixin to avoid rel attributes being rendered for HAL.
|
Modifier and Type | Method and Description |
---|---|
protected Link |
HalLinkDiscoverer.extractLink(Object element,
LinkRelation rel) |
static Link |
LinkMixin.of(String href) |
Modifier and Type | Method and Description |
---|---|
List<Link> |
Jackson2HalModule.HalLinkListDeserializer.deserialize(com.fasterxml.jackson.core.JsonParser jp,
com.fasterxml.jackson.databind.DeserializationContext ctxt) |
Modifier and Type | Method and Description |
---|---|
HalModelBuilder |
HalModelBuilder.PreviewBuilder.forLink(Link link)
Concludes the set up of a preview for the given
Link . |
HalLinkRelation |
CurieProvider.getNamespacedRelFrom(Link link)
Returns the rel to be rendered for the given
Link . |
HalLinkRelation |
DefaultCurieProvider.getNamespacedRelFrom(Link link) |
HalModelBuilder |
HalModelBuilder.link(Link link)
Add a
Link to the whole thing. |
Modifier and Type | Method and Description |
---|---|
HalModelBuilder |
HalModelBuilder.links(Iterable<Link> links)
Adds the given
Link s to the RepresentationModel to be built. |
Modifier and Type | Method and Description |
---|---|
Optional<Link> |
UberLinkDiscoverer.findLinkWithRel(LinkRelation rel,
InputStream representation) |
Optional<Link> |
UberLinkDiscoverer.findLinkWithRel(LinkRelation rel,
String representation) |
Modifier and Type | Method and Description |
---|---|
VndErrors |
VndErrors.withLink(Link link)
Deprecated.
|
VndErrors |
VndErrors.withLinks(Link... links)
Deprecated.
|
Constructor and Description |
---|
VndError(String logref,
String message,
Link... links)
Deprecated.
Use
VndError(String, String, Object, Link...) (with proper ordering of arguments) |
VndError(String message,
String path,
Object logref,
Link... link)
Deprecated.
|
VndErrors(Object logref,
String message,
Link... links)
Deprecated.
Creates a new
VndErrors instance containing a single VndErrors.VndError with the given logref, message and
optional Link s. |
Constructor and Description |
---|
VndError(String message,
String path,
Object logref,
List<Link> links)
Deprecated.
Creates a new
VndErrors.VndError with a message and optional a path and a logref. |
Modifier and Type | Method and Description |
---|---|
Link |
TypedEntityLinks.ExtendedTypedEntityLinks.linkToCollectionResource()
Creates a
Link pointing to the collection resource of the configured type. |
Link |
EntityLinks.linkToCollectionResource(Class<?> type)
Creates a
Link pointing to the collection resource of the given type. |
Link |
EntityLinks.linkToItemResource(Class<?> type,
Object id)
Creates a
Link pointing to item resource backing the given entity type and id. |
Link |
TypedEntityLinks.linkToItemResource(T entity)
Creates a
Link pointing to item resource backing the given entity. |
default <T> Link |
EntityLinks.linkToItemResource(T entity,
Function<T,Object> identifierExtractor)
Creates a
Link pointing to item resource backing the given entity and identifier extractor. |
Link |
LinkBuilder.withRel(LinkRelation rel)
Creates the
Link built by the current builder instance with the given LinkRelation . |
default Link |
LinkBuilder.withRel(String rel)
Creates the
Link built by the current builder instance with the given link relation. |
Link |
LinkBuilder.withSelfRel()
Creates the
Link built by the current builder instance with the default self link relation. |
Modifier and Type | Method and Description |
---|---|
Link |
ControllerEntityLinks.linkToCollectionResource(Class<?> entity) |
Link |
DelegatingEntityLinks.linkToCollectionResource(Class<?> type) |
Link |
ControllerEntityLinks.linkToItemResource(Class<?> entity,
Object id) |
Link |
DelegatingEntityLinks.linkToItemResource(Class<?> type,
Object id) |
Link |
LinkBuilderSupport.withRel(LinkRelation rel) |
Link |
LinkBuilderSupport.withSelfRel() |
Modifier and Type | Method and Description |
---|---|
static Link |
MvcLink.of(Object invocation,
LinkRelation relation)
Creates a new
Link from the given MvcUriComponentsBuilder invocation. |
static Link |
MvcLink.of(Supplier<Object> invocation,
LinkRelation relation)
Creates a new
Link from the given lazy MvcUriComponentsBuilder invocation. |
Modifier and Type | Method and Description |
---|---|
reactor.core.publisher.Mono<Link> |
WebFluxLinkBuilder.WebFluxLink.toMono()
Returns the underlying
Mono of Link for further handling within a reactive pipeline. |
reactor.core.publisher.Mono<Link> |
WebFluxLinkBuilder.WebFluxLink.toMono(Function<Link,Link> finisher)
|
Modifier and Type | Method and Description |
---|---|
WebFluxLinkBuilder.WebFluxLink |
WebFluxLinkBuilder.WebFluxLink.map(Function<Link,Link> mapper)
Creates a new
WebFluxLinkBuilder.WebFluxLink with the current Link instance transformed using the given mapper. |
WebFluxLinkBuilder.WebFluxLink |
WebFluxLinkBuilder.WebFluxLink.map(Function<Link,Link> mapper)
Creates a new
WebFluxLinkBuilder.WebFluxLink with the current Link instance transformed using the given mapper. |
WebFluxLinkBuilder.WebFluxLink |
WebFluxLinkBuilder.WebFluxBuilder.toLink(Function<WebFluxLinkBuilder,reactor.core.publisher.Mono<Link>> finisher)
General callback to produce a
Link from the given WebFluxLinkBuilder . |
reactor.core.publisher.Mono<Link> |
WebFluxLinkBuilder.WebFluxLink.toMono(Function<Link,Link> finisher)
|
reactor.core.publisher.Mono<Link> |
WebFluxLinkBuilder.WebFluxLink.toMono(Function<Link,Link> finisher)
|
Constructor and Description |
---|
WebFluxLink(reactor.core.publisher.Mono<Link> link) |
Copyright © 2011–2021 VMware, Inc.. All rights reserved.