Package de.kamillionlabs.hateoflux.assembler

Schnittstelle SealedEmbeddedLinkAssemblerModule<EmbeddedT>

Typparameter:
EmbeddedT - the type of the object representing additional embedded resources related to the main data
Alle bekannten Unterschnittstellen:
EmbeddingHalWrapperAssembler<ResourceT,EmbeddedT>, SealedNonReactiveEmbeddingHalWrapperAssembler<ResourceT,EmbeddedT>
public sealed interface SealedEmbeddedLinkAssemblerModule<EmbeddedT> permits SealedNonReactiveEmbeddingHalWrapperAssembler<ResourceT,EmbeddedT>
Assembler module that builds links for an embedded resource.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    default List<Link>
    buildLinksForEmbedded(EmbeddedT embedded, org.springframework.web.server.ServerWebExchange exchange)
    Main method for building all links for a given embedded resource, including a self-link and other contextual links.
    default List<Link>
    buildOtherLinksForEmbedded(EmbeddedT embedded, org.springframework.web.server.ServerWebExchange exchange)
    Provides additional contextual links for a given embedded resource, beyond the self-link.
    Link
    buildSelfLinkForEmbedded(EmbeddedT embedded, org.springframework.web.server.ServerWebExchange exchange)
    Creates a self-link for a given embedded resource, representing a URI that clients can use to access the resource directly.

  • Methodendetails

    • buildLinksForEmbedded

      default List<Link> buildLinksForEmbedded(EmbeddedT embedded, org.springframework.web.server.ServerWebExchange exchange)
      Main method for building all links for a given embedded resource, including a self-link and other contextual links. It aggregates results from buildSelfLinkForEmbedded(EmbeddedT, org.springframework.web.server.ServerWebExchange) and buildOtherLinksForEmbedded(EmbeddedT, org.springframework.web.server.ServerWebExchange).
      Parameter:
      embedded - the embedded resource for which links are constructed
      exchange - provides the context of the current web exchange, such as the base URL
      Gibt zurück:
      a list of Link objects representing hypermedia links for the embedded resource

    • buildSelfLinkForEmbedded

      Link buildSelfLinkForEmbedded(EmbeddedT embedded, org.springframework.web.server.ServerWebExchange exchange)
      Creates a self-link for a given embedded resource, representing a URI that clients can use to access the resource directly.
      Parameter:
      embedded - the embedded resource for which a self-link is created
      exchange - provides the context of the current web exchange, such as the base URL
      Gibt zurück:
      a Link object representing the self-link for the embedded resource

    • buildOtherLinksForEmbedded

      default List<Link> buildOtherLinksForEmbedded(EmbeddedT embedded, org.springframework.web.server.ServerWebExchange exchange)
      Provides additional contextual links for a given embedded resource, beyond the self-link.
      Parameter:
      embedded - the embedded resource for which additional links are generated
      exchange - provides the context of the current web exchange, such as the base URL
      Gibt zurück:
      a list of Link objects representing additional hypermedia links for the embedded resource