org.jboss.aerogear.controller.router.rest.pagination

Class OffsetPagingStrategy

java.lang.Object

org.jboss.aerogear.controller.router.rest.pagination.OffsetPagingStrategy

All Implemented Interfaces:

PagingStrategy

public class OffsetPagingStrategy
extends Object
implements PagingStrategy

A PagingStrategy that uses an offset/limit to add HTTP headers to the response.

The current implementation adds the following HTTP headers:

• AG-Next
• AG-Previous

The above headers acts as links to the next/previous pages of data.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LIMIT_PARAM_NAME
static String	DEFAULT_OFFSET_PARAM_NAME
private com.google.common.base.Optional<String>	headerPrefix
private PaginationInfo	pagingInfo

Constructor Summary

Constructors

Modifier	Constructor and Description
	OffsetPagingStrategy(PaginationInfo paginationInfo)
private	OffsetPagingStrategy(PaginationInfo paginationInfo, com.google.common.base.Optional<String> headerPrefix)
	OffsetPagingStrategy(PaginationInfo paginationInfo, String headerPrefix)

Method Summary

Methods

Modifier and Type	Method and Description
private PagingMetadata	createMetadata(RouteContext routeContext)
PaginationInfo	getPaginationInfo() Returns the PaginationInfo for the current request.
private String	getResourcePath(RouteContext routeContext)
Object	process(Object result, RouteContext routeContext) Process allows for manipulating the result of an endpoint target method invocation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_OFFSET_PARAM_NAME

public static final String DEFAULT_OFFSET_PARAM_NAME

See Also:

Constant Field Values

DEFAULT_LIMIT_PARAM_NAME

public static final String DEFAULT_LIMIT_PARAM_NAME

See Also:

Constant Field Values

pagingInfo

private final PaginationInfo pagingInfo

headerPrefix

private final com.google.common.base.Optional<String> headerPrefix

Constructor Detail

OffsetPagingStrategy

public OffsetPagingStrategy(PaginationInfo paginationInfo)

OffsetPagingStrategy

public OffsetPagingStrategy(PaginationInfo paginationInfo,
                    String headerPrefix)

OffsetPagingStrategy

private OffsetPagingStrategy(PaginationInfo paginationInfo,
                    com.google.common.base.Optional<String> headerPrefix)

Method Detail

process

public Object process(Object result,
             RouteContext routeContext)

Description copied from interface: PagingStrategy

Process allows for manipulating the result of an endpoint target method invocation.

Specified by:

process in interface PagingStrategy

Parameters:

result - the result returned from the target endpoint method.

routeContext - the RouteContext.

Returns:

Object Either the unchanged result or a modified result depending on the underlying implementation.

createMetadata

private PagingMetadata createMetadata(RouteContext routeContext)

getResourcePath

private String getResourcePath(RouteContext routeContext)

getPaginationInfo

public PaginationInfo getPaginationInfo()

Description copied from interface: PagingStrategy

Returns the PaginationInfo for the current request.

Specified by:

getPaginationInfo in interface PagingStrategy

Returns:

PaginationInfo for the current request.