forked from kbss-cvut/record-manager
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[kbss-cvut/record-manager-ui#71] Return HATEOAS response headers when…
… using paging.
- Loading branch information
Showing
7 changed files
with
427 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
src/main/java/cz/cvut/kbss/study/rest/event/PaginatedResultRetrievedEvent.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| package cz.cvut.kbss.study.rest.event; | ||
|
|
||
| import jakarta.servlet.http.HttpServletResponse; | ||
| import org.springframework.context.ApplicationEvent; | ||
| import org.springframework.data.domain.Page; | ||
| import org.springframework.web.util.UriComponentsBuilder; | ||
|
|
||
| /** | ||
| * Fired when a paginated result is retrieved by a REST controller, so that HATEOAS headers can be added to the | ||
| * response. | ||
| */ | ||
| public class PaginatedResultRetrievedEvent extends ApplicationEvent { | ||
|
|
||
| private final UriComponentsBuilder uriBuilder; | ||
| private final HttpServletResponse response; | ||
| private final Page<?> page; | ||
|
|
||
| public PaginatedResultRetrievedEvent(Object source, UriComponentsBuilder uriBuilder, HttpServletResponse response, | ||
| Page<?> page) { | ||
| super(source); | ||
| this.uriBuilder = uriBuilder; | ||
| this.response = response; | ||
| this.page = page; | ||
| } | ||
|
|
||
| public UriComponentsBuilder getUriBuilder() { | ||
| return uriBuilder; | ||
| } | ||
|
|
||
| public HttpServletResponse getResponse() { | ||
| return response; | ||
| } | ||
|
|
||
| public Page<?> getPage() { | ||
| return page; | ||
| } | ||
| } |
80 changes: 80 additions & 0 deletions
80
src/main/java/cz/cvut/kbss/study/rest/handler/HateoasPagingListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| package cz.cvut.kbss.study.rest.handler; | ||
|
|
||
| import cz.cvut.kbss.study.rest.event.PaginatedResultRetrievedEvent; | ||
| import cz.cvut.kbss.study.rest.util.HttpPaginationLink; | ||
| import cz.cvut.kbss.study.util.Constants; | ||
| import org.springframework.context.ApplicationListener; | ||
| import org.springframework.data.domain.Page; | ||
| import org.springframework.http.HttpHeaders; | ||
| import org.springframework.stereotype.Component; | ||
| import org.springframework.web.util.UriComponentsBuilder; | ||
|
|
||
| /** | ||
| * Generates HATEOAS paging headers based on the paginated result retrieved by a REST controller. | ||
| */ | ||
| @Component | ||
| public class HateoasPagingListener implements ApplicationListener<PaginatedResultRetrievedEvent> { | ||
|
|
||
| @Override | ||
| public void onApplicationEvent(PaginatedResultRetrievedEvent event) { | ||
| final Page<?> page = event.getPage(); | ||
| final LinkHeader header = new LinkHeader(); | ||
| if (page.hasNext()) { | ||
| header.addLink(generateNextPageLink(page, event.getUriBuilder()), HttpPaginationLink.NEXT); | ||
| header.addLink(generateLastPageLink(page, event.getUriBuilder()), HttpPaginationLink.LAST); | ||
| } | ||
| if (page.hasPrevious()) { | ||
| header.addLink(generatePreviousPageLink(page, event.getUriBuilder()), HttpPaginationLink.PREVIOUS); | ||
| header.addLink(generateFirstPageLink(page, event.getUriBuilder()), HttpPaginationLink.FIRST); | ||
| } | ||
| if (header.hasLinks()) { | ||
| event.getResponse().addHeader(HttpHeaders.LINK, header.toString()); | ||
| } | ||
| } | ||
|
|
||
| private String generateNextPageLink(Page<?> page, UriComponentsBuilder uriBuilder) { | ||
| return uriBuilder.replaceQueryParam(Constants.PAGE_PARAM, page.getNumber() + 1) | ||
| .replaceQueryParam(Constants.PAGE_SIZE_PARAM, page.getSize()) | ||
| .build().encode().toUriString(); | ||
| } | ||
|
|
||
| private String generatePreviousPageLink(Page<?> page, UriComponentsBuilder uriBuilder) { | ||
| return uriBuilder.replaceQueryParam(Constants.PAGE_PARAM, page.getNumber() - 1) | ||
| .replaceQueryParam(Constants.PAGE_SIZE_PARAM, page.getSize()) | ||
| .build().encode().toUriString(); | ||
| } | ||
|
|
||
| private String generateFirstPageLink(Page<?> page, UriComponentsBuilder uriBuilder) { | ||
| return uriBuilder.replaceQueryParam(Constants.PAGE_PARAM, 0) | ||
| .replaceQueryParam(Constants.PAGE_SIZE_PARAM, page.getSize()) | ||
| .build().encode().toUriString(); | ||
| } | ||
|
|
||
| private String generateLastPageLink(Page<?> page, UriComponentsBuilder uriBuilder) { | ||
| return uriBuilder.replaceQueryParam(Constants.PAGE_PARAM, page.getTotalPages() - 1) | ||
| .replaceQueryParam(Constants.PAGE_SIZE_PARAM, page.getSize()) | ||
| .build().encode().toUriString(); | ||
| } | ||
|
|
||
| private static class LinkHeader { | ||
|
|
||
| private final StringBuilder linkBuilder = new StringBuilder(); | ||
|
|
||
| private void addLink(String url, HttpPaginationLink type) { | ||
| if (!linkBuilder.isEmpty()) { | ||
| linkBuilder.append(", "); | ||
| } | ||
| linkBuilder.append('<').append(url).append('>').append("; ").append("rel=\"").append(type.getName()) | ||
| .append('"'); | ||
| } | ||
|
|
||
| private boolean hasLinks() { | ||
| return !linkBuilder.isEmpty(); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return linkBuilder.toString(); | ||
| } | ||
| } | ||
| } |
18 changes: 18 additions & 0 deletions
18
src/main/java/cz/cvut/kbss/study/rest/util/HttpPaginationLink.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| package cz.cvut.kbss.study.rest.util; | ||
|
|
||
| /** | ||
| * Types of HTTP pagination links. | ||
| */ | ||
| public enum HttpPaginationLink { | ||
| NEXT("next"), PREVIOUS("prev"), FIRST("first"), LAST("last"); | ||
|
|
||
| private final String name; | ||
|
|
||
| HttpPaginationLink(String name) { | ||
| this.name = name; | ||
| } | ||
|
|
||
| public String getName() { | ||
| return name; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.