Package de.kamillionlabs.hateoflux.assembler

Schnittstelle SealedNonReactiveEmbeddingHalWrapperAssembler<ResourceT,EmbeddedT>

Typparameter:

ResourceT - the type of the object being wrapped, which contains the main data

EmbeddedT - the type of the object representing additional embedded resources related to the main data, if any

Alle Superschnittstellen:

SealedEmbeddedLinkAssemblerModule<EmbeddedT>, SealedResourceLinkAssemblerModule<ResourceT>, SealedResourceListAssemblerModule<ResourceT,EmbeddedT>

Alle bekannten Unterschnittstellen:

EmbeddingHalWrapperAssembler<ResourceT,EmbeddedT>

public sealed interface SealedNonReactiveEmbeddingHalWrapperAssembler<ResourceT,EmbeddedT>
extends SealedResourceLinkAssemblerModule<ResourceT>, SealedResourceListAssemblerModule<ResourceT,EmbeddedT>, SealedEmbeddedLinkAssemblerModule<EmbeddedT>
permits EmbeddingHalWrapperAssembler<ResourceT,EmbeddedT>

Interface for managing the transformation of resources and their associated embedded resources into HAL-compliant representations, supplemented with hypermedia links. This interface facilitates the direct enhancement of resources with the necessary fields and structure to comply with HAL standards, enabling resources to become HAL-compliant.

Core functionalities include:

• Directly enhancing main resources and their embedded resources to meet HAL structure requirements.
• Appending hypermedia links to resources to support navigability and resource interaction in a HAL-based API.
• Enabling custom naming and linking definitions for collections of embedded resources through implementation.
• Supporting pagination when wrapping lists of resources to provide structured navigation across large datasets.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Class<EmbeddedT>	getEmbeddedTClass()	Specifies the class type of EmbeddedT that the assembler builds.
default HalListWrapper<ResourceT,EmbeddedT>	wrapInListWrapper(MultiRightPairList<ResourceT,EmbeddedT> resourcesToWrap, long totalElements, int pageSize, Long offset, List<SortCriteria> sortCriteria, org.springframework.web.server.ServerWebExchange exchange)	Wraps a list of main resources with their corresponding list of embedded resources in a HalListWrapper with pagination information, appending hypermedia links as defined by the assembler.
default HalListWrapper<ResourceT,EmbeddedT>	wrapInListWrapper(MultiRightPairList<ResourceT,EmbeddedT> resourcesToWrap, HalPageInfo pageInfo, List<SortCriteria> sortCriteria, org.springframework.web.server.ServerWebExchange exchange)	Wraps a list of main resources with their corresponding list of embedded resources in a HalListWrapper, optionally including pagination information, appending hypermedia links as defined by the assembler.
default HalListWrapper<ResourceT,EmbeddedT>	wrapInListWrapper(MultiRightPairList<ResourceT,EmbeddedT> resourcesToWrap, org.springframework.web.server.ServerWebExchange exchange)	Wraps a list of main resources with their corresponding list of embedded resources in a HalListWrapper, appending hypermedia links as defined by the assembler.
default HalListWrapper<ResourceT,EmbeddedT>	wrapInListWrapper(PairList<ResourceT,EmbeddedT> resourcesToWrap, long totalElements, int pageSize, Long offset, List<SortCriteria> sortCriteria, org.springframework.web.server.ServerWebExchange exchange)	Wraps a list of main resources with their corresponding embedded resources in a HalListWrapper with pagination information, appending hypermedia links as defined by the assembler.
default HalListWrapper<ResourceT,EmbeddedT>	wrapInListWrapper(PairList<ResourceT,EmbeddedT> resourcesToWrap, HalPageInfo pageInfo, List<SortCriteria> sortCriteria, org.springframework.web.server.ServerWebExchange exchange)	Wraps a list of main resources with their corresponding embedded resources in a HalListWrapper, optionally including pagination information, appending hypermedia links as defined by the assembler.
default HalListWrapper<ResourceT,EmbeddedT>	wrapInListWrapper(PairList<ResourceT,EmbeddedT> resourcesToWrap, org.springframework.web.server.ServerWebExchange exchange)	Wraps a list of main resources with their corresponding embedded resources in a HalListWrapper, appending hypermedia links as defined by the assembler.
default HalResourceWrapper<ResourceT,EmbeddedT>	wrapInResourceWrapper(ResourceT resourceToWrap, EmbeddedT embedded, org.springframework.web.server.ServerWebExchange exchange)	Wraps a single main resource and its corresponding embedded resource in a HalResourceWrapper, appending hypermedia links as defined by the assembler.
default HalResourceWrapper<ResourceT,EmbeddedT>	wrapInResourceWrapper(ResourceT resourceToWrap, Class<EmbeddedT> embeddedTypeAsNameOrigin, List<EmbeddedT> embeddedList, org.springframework.web.server.ServerWebExchange exchange)	Wraps a single main resource and its list of embedded resources, with the list name derived from the specified class embeddedTypeAsNameOrigin, in a HalResourceWrapper, appending hypermedia links as defined by the assembler.
default HalResourceWrapper<ResourceT,EmbeddedT>	wrapInResourceWrapper(ResourceT resourceToWrap, String embeddedListName, List<EmbeddedT> embeddedList, org.springframework.web.server.ServerWebExchange exchange)	Wraps a single main resource and its list of embedded resources, identified by a directly provided list name, in a HalResourceWrapper, appending hypermedia links as defined by the assembler.
default HalResourceWrapper<ResourceT,EmbeddedT>	wrapInResourceWrapper(ResourceT resourceToWrap, List<EmbeddedT> embeddedList, org.springframework.web.server.ServerWebExchange exchange)	Wraps a single main resource and a non-empty list of its embedded resources in a HalResourceWrapper, appending hypermedia links as defined by the assembler.

Von Schnittstelle geerbte Methoden de.kamillionlabs.hateoflux.assembler.SealedEmbeddedLinkAssemblerModule

buildLinksForEmbedded, buildOtherLinksForEmbedded, buildSelfLinkForEmbedded

Von Schnittstelle geerbte Methoden de.kamillionlabs.hateoflux.assembler.SealedResourceLinkAssemblerModule

buildLinksForResource, buildOtherLinksForResource, buildSelfLinkForResource

Von Schnittstelle geerbte Methoden de.kamillionlabs.hateoflux.assembler.SealedResourceListAssemblerModule

buildLinksForResourceList, buildLinksForResourceList, buildOtherLinksForResourceList, buildSelfLinkForResourceList, createEmptyListWrapper, createEmptyListWrapper, createEmptyListWrapper, createEmptyListWrapper, getResourceTClass

Methodendetails

getEmbeddedTClass

Class<EmbeddedT> getEmbeddedTClass()

Specifies the class type of EmbeddedT that the assembler builds. This method is required because type erasure removes generic type information at runtime. By implementing this method, the class type of EmbeddedT becomes accessible. An implementation is as simple as:

 public Class<Author> getEmbeddedTClass() {
     return Author.class;
 }
 

Gibt zurück:

the class type of EmbeddedT

wrapInListWrapper

default HalListWrapper<ResourceT,EmbeddedT> wrapInListWrapper(@NonNull
 PairList<ResourceT,EmbeddedT> resourcesToWrap,
 @Nullable
 HalPageInfo pageInfo,
 @Nullable
 List<SortCriteria> sortCriteria,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a list of main resources with their corresponding embedded resources in a HalListWrapper, optionally including pagination information, appending hypermedia links as defined by the assembler.

The embedded resources in the PairList are allowed to be null resulting in the removal of the _embedded node in the serialized JSON.

Parameter:

resourcesToWrap - the list of main resources and their corresponding embedded resources to wrap

pageInfo - optional pagination information to include in the wrapper

sortCriteria - sort criteria (property and direction) of the page

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalListWrapper enriched with hypermedia links and optional pagination details

Siehe auch:

• wrapInListWrapper(PairList, long, int, Long, List, ServerWebExchange)
• wrapInListWrapper(PairList, ServerWebExchange)

wrapInListWrapper

default HalListWrapper<ResourceT,EmbeddedT> wrapInListWrapper(@NonNull
 PairList<ResourceT,EmbeddedT> resourcesToWrap,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a list of main resources with their corresponding embedded resources in a HalListWrapper, appending hypermedia links as defined by the assembler.

The embedded resources in the PairList are allowed to be null resulting in the removal of the _embedded node in the serialized JSON.

Parameter:

resourcesToWrap - the list of main resources and their corresponding embedded resources to wrap

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalListWrapper equipped with hypermedia links for each resource and the list as a whole

Siehe auch:

• wrapInListWrapper(PairList, long, int, Long, List, ServerWebExchange)
• wrapInListWrapper(PairList, HalPageInfo, List, ServerWebExchange)

wrapInListWrapper

default HalListWrapper<ResourceT,EmbeddedT> wrapInListWrapper(@NonNull
 PairList<ResourceT,EmbeddedT> resourcesToWrap,
 long totalElements,
 int pageSize,
 @Nullable
 Long offset,
 List<SortCriteria> sortCriteria,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a list of main resources with their corresponding embedded resources in a HalListWrapper with pagination information, appending hypermedia links as defined by the assembler.

The embedded resources in the PairList are allowed to be null resulting in the removal of the _embedded node in the serialized JSON.

Parameter:

resourcesToWrap - the list of main resources and their corresponding embedded resources to wrap

totalElements - the total number of elements across all pages

pageSize - the requested/max number of elements in a single page

offset - the starting offset of the page, if specified

sortCriteria - sort criteria (property and direction) of the page

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalListWrapper with hypermedia links and pagination information

Siehe auch:

• wrapInListWrapper(PairList, HalPageInfo, List, ServerWebExchange)
• wrapInListWrapper(PairList, ServerWebExchange)

wrapInListWrapper

default HalListWrapper<ResourceT,EmbeddedT> wrapInListWrapper(@NonNull
 MultiRightPairList<ResourceT,EmbeddedT> resourcesToWrap,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a list of main resources with their corresponding list of embedded resources in a HalListWrapper, appending hypermedia links as defined by the assembler.

The embedded resources (list) for a main resource i.e. the list with the right elements of the MultiRightPairList, is allowed to be empty or null resulting in either the removal of the _embedded node or the addition of an empty array in the _embedded node in the serialized JSON.

Parameter:

resourcesToWrap - the list of main resources and their corresponding list of embedded resources to wrap

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalListWrapper equipped with hypermedia links for each resource and the list as a whole

Siehe auch:

• wrapInListWrapper(MultiRightPairList, long, int, Long, List, ServerWebExchange)
• wrapInListWrapper(MultiRightPairList, HalPageInfo, List, ServerWebExchange)

wrapInListWrapper

default HalListWrapper<ResourceT,EmbeddedT> wrapInListWrapper(@NonNull
 MultiRightPairList<ResourceT,EmbeddedT> resourcesToWrap,
 long totalElements,
 int pageSize,
 @Nullable
 Long offset,
 List<SortCriteria> sortCriteria,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a list of main resources with their corresponding list of embedded resources in a HalListWrapper with pagination information, appending hypermedia links as defined by the assembler.

The embedded resources (list) for a main resource i.e. the list with the right elements of the MultiRightPairList, is allowed to be empty or null resulting in either the removal of the _embedded node or the addition of an empty array in the _embedded node in the serialized JSON.

Parameter:

resourcesToWrap - the list of main resources and their corresponding list of embedded resources to wrap

totalElements - the total number of elements across all pages

pageSize - the requested/max number of elements in a single page

offset - the starting offset of the page, if specified

sortCriteria - sort criteria (property and direction) of the page

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalListWrapper with hypermedia links and pagination information

Siehe auch:

• wrapInListWrapper(MultiRightPairList, HalPageInfo, List, ServerWebExchange)
• wrapInListWrapper(MultiRightPairList, ServerWebExchange)

wrapInListWrapper

default HalListWrapper<ResourceT,EmbeddedT> wrapInListWrapper(@NonNull
 MultiRightPairList<ResourceT,EmbeddedT> resourcesToWrap,
 @Nullable
 HalPageInfo pageInfo,
 @Nullable
 List<SortCriteria> sortCriteria,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a list of main resources with their corresponding list of embedded resources in a HalListWrapper, optionally including pagination information, appending hypermedia links as defined by the assembler.

The embedded resources (list) for a main resource i.e. the list with the right elements of the MultiRightPairList, is allowed to be empty or null resulting in either the removal of the _embedded node or the addition of an empty array in the _embedded node in the serialized JSON.

Parameter:

resourcesToWrap - the list of main resources and their corresponding list of embedded resources to wrap

pageInfo - optional pagination information to include in the wrapper

sortCriteria - sort criteria (property and direction) of the page

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalListWrapper enriched with hypermedia links and optional pagination details

Siehe auch:

• wrapInListWrapper(MultiRightPairList, long, int, Long, List, ServerWebExchange)
• wrapInListWrapper(MultiRightPairList, ServerWebExchange)

wrapInResourceWrapper

default HalResourceWrapper<ResourceT,EmbeddedT> wrapInResourceWrapper(@NonNull
 ResourceT resourceToWrap,
 EmbeddedT embedded,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a single main resource and its corresponding embedded resource in a HalResourceWrapper, appending hypermedia links as defined by the assembler.

The embedded resources is allowed to be null resulting in the removal of the _embedded node in the serialized JSON.

Parameter:

resourceToWrap - the main resource to wrap

embedded - the embedded resource associated with the main resource

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalResourceWrapper with hypermedia links for the resource and its embedded counterpart

Siehe auch:

• wrapInResourceWrapper(Object, List, ServerWebExchange)

wrapInResourceWrapper

default HalResourceWrapper<ResourceT,EmbeddedT> wrapInResourceWrapper(@NonNull
 ResourceT resourceToWrap,
 List<EmbeddedT> embeddedList,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a single main resource and a non-empty list of its embedded resources in a HalResourceWrapper, appending hypermedia links as defined by the assembler.

The embeddedList is allowed to be empty or null resulting in either the removal of the _embedded node or the addition of an empty array in the _embedded node in the serialized JSON.

Parameter:

resourceToWrap - the main resource to wrap

embeddedList - the non-empty list of embedded resources associated with the main resource; the list name is derived from the embedded resource's class name (see also Relation)

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalResourceWrapper that includes the main resource and its embedded resources, all enhanced with hypermedia links

Löst aus:

IllegalArgumentException - if the embedded list is null or empty

Siehe auch:

• wrapInResourceWrapper(Object, Object, ServerWebExchange)
• wrapInResourceWrapper(Object, String, List, ServerWebExchange)
• wrapInResourceWrapper(Object, Class, List, ServerWebExchange)

wrapInResourceWrapper

default HalResourceWrapper<ResourceT,EmbeddedT> wrapInResourceWrapper(@NonNull
 ResourceT resourceToWrap,
 @NonNull
 String embeddedListName,
 List<EmbeddedT> embeddedList,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a single main resource and its list of embedded resources, identified by a directly provided list name, in a HalResourceWrapper, appending hypermedia links as defined by the assembler. The list is allowed to be empty.

The embeddedList is allowed to be empty or null resulting in either the removal of the _embedded node or the addition of an empty array in the _embedded node in the serialized JSON.

Parameter:

resourceToWrap - the main resource to wrap

embeddedListName - the explicitly provided name for the list of embedded resources

embeddedList - the list of embedded resources associated with the main resource, which may be empty

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalResourceWrapper that includes the main resource and its embedded resources, all enhanced with hypermedia links

Siehe auch:

• wrapInResourceWrapper(Object, Object, ServerWebExchange)
• wrapInResourceWrapper(Object, Class, List, ServerWebExchange)
• wrapInResourceWrapper(Object, List, ServerWebExchange)

wrapInResourceWrapper

default HalResourceWrapper<ResourceT,EmbeddedT> wrapInResourceWrapper(@NonNull
 ResourceT resourceToWrap,
 @NonNull
 Class<EmbeddedT> embeddedTypeAsNameOrigin,
 List<EmbeddedT> embeddedList,
 org.springframework.web.server.ServerWebExchange exchange)

Wraps a single main resource and its list of embedded resources, with the list name derived from the specified class embeddedTypeAsNameOrigin, in a HalResourceWrapper, appending hypermedia links as defined by the assembler.

The embeddedList is allowed to be empty or null resulting in either the removal of the _embedded node or the addition of an empty array in the _embedded node in the serialized JSON.

Parameter:

resourceToWrap - the main resource to wrap

embeddedTypeAsNameOrigin - the class from which the list name is derived (see also Relation)

embeddedList - the list of embedded resources associated with the main resource, which may be empty

exchange - provides the context of the current web exchange, such as the base URL

Gibt zurück:

a HalResourceWrapper that includes the main resource and its derived named embedded resources, all enhanced with hypermedia links

Siehe auch:

• wrapInResourceWrapper(Object, Object, ServerWebExchange)
• wrapInResourceWrapper(Object, String, List, ServerWebExchange)
• wrapInResourceWrapper(Object, List, ServerWebExchange)