Spring/spring-data-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATACMNS-701 - PagedResourcesAssembler now adds first and last links.

Browse Source 
We now add first and last links to the PagedResources created in line with the appearance of the prev and next links. The PagedResourcesAssembler can be configured to enforce the rendering using setForceFirstAndLastRels(…).
This commit is contained in:
Oliver Gierke
2015-05-19 08:28:06 +02:00
parent c5aaebd0e4
commit 62170ab767
2 changed files with 93 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
src/main/java/org/springframework/data/web/PagedResourcesAssembler.java
View File

@@ -23,6 +23,7 @@ import java.util.List;
import org.springframework.core.MethodParameter;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.PagedResources;
@@ -51,6 +52,8 @@ public class PagedResourcesAssembler<T> implements ResourceAssembler<Page<T>, Pa
private final UriComponents baseUri;
private final EmbeddedWrappers wrappers = new EmbeddedWrappers(false);
private boolean forceFirstAndLastRels = false;
/**
* Creates a new {@link PagedResourcesAssembler} using the given {@link PageableHandlerMethodArgumentResolver} and
* base URI. If the former is {@literal null}, a default one will be created. If the latter is {@literal null}, calls
@@ -65,6 +68,19 @@ public class PagedResourcesAssembler<T> implements ResourceAssembler<Page<T>, Pa
this.baseUri = baseUri;
}
/**
* Configures whether to always add {@code first} and {@code last} links to the {@link PagedResources} created.
* Defaults to {@literal false} which means that {@code first} and {@code last} links only appear in conjunction with
* {@code prev} and {@code next} links.
*
* @param forceFirstAndLastRels whether to always add {@code first} and {@code last} links to the
* {@link PagedResources} created.
* @since 1.11
*/
public void setForceFirstAndLastRels(boolean forceFirstAndLastRels) {
this.forceFirstAndLastRels = forceFirstAndLastRels;
}
/*
* (non-Javadoc)
* @see org.springframework.hateoas.ResourceAssembler#toResource(java.lang.Object)
@@ -136,8 +152,7 @@ public class PagedResourcesAssembler<T> implements ResourceAssembler<Page<T>, Pa
EmbeddedWrapper wrapper = wrappers.emptyCollectionOf(type);
List<EmbeddedWrapper> embedded = Collections.singletonList(wrapper);
return new PagedResources<EmbeddedWrapper>(embedded, metadata,
createLink(getUriTemplate(link), null, Link.REL_SELF));
return addPaginationLinks(new PagedResources<EmbeddedWrapper>(embedded, metadata), page, link);
}
/**
@@ -167,20 +182,35 @@ public class PagedResourcesAssembler<T> implements ResourceAssembler<Page<T>, Pa
resources.add(assembler.toResource(element));
}
return addPaginationLinks(new PagedResources<R>(resources, asPageMetadata(page)), page, link);
}
private <R> PagedResources<R> addPaginationLinks(PagedResources<R> resources, Page<?> page, Link link) {
UriTemplate base = getUriTemplate(link);
Link selfLink = createLink(base, null, Link.REL_SELF);
PagedResources<R> pagedResources = new PagedResources<R>(resources, asPageMetadata(page), selfLink);
if (page.hasNext()) {
pagedResources.add(createLink(base, page.nextPageable(), Link.REL_NEXT));
if (page.hasPrevious() || forceFirstAndLastRels) {
resources.add(createLink(base, new PageRequest(0, page.getSize(), page.getSort()), Link.REL_FIRST));
}
if (page.hasPrevious()) {
pagedResources.add(createLink(base, page.previousPageable(), Link.REL_PREVIOUS));
resources.add(createLink(base, page.previousPageable(), Link.REL_PREVIOUS));
}
return pagedResources;
resources.add(createLink(base, null, Link.REL_SELF));
if (page.hasNext()) {
resources.add(createLink(base, page.nextPageable(), Link.REL_NEXT));
}
if (page.hasNext() || forceFirstAndLastRels) {
int lastIndex = page.getTotalPages() == 0 ? 0 : page.getTotalPages() - 1;
resources.add(createLink(base, new PageRequest(lastIndex, page.getSize(), page.getSort()), Link.REL_LAST));
}
return resources;
}
/**