com.emc.atmos.api.request

Class ListRequest<T extends ListRequest<T>>

java.lang.Object

com.emc.atmos.api.request.Request

com.emc.atmos.api.request.ListRequest<T>

Type Parameters:

T - Represents the implementation type. Allows a consistent builder interface throughout the request hierarchy. Parameterize concrete subclasses with their own type and implement me() to return "this". In abstract subclasses, return me() in builder methods.

Direct Known Subclasses:

ListAccessTokensRequest, ListMetadataRequest, ListVersionsRequest

public abstract class ListRequest<T extends ListRequest<T>>
extends Request

Common elements of a request for a list of items. Atmos uses the limit and token headers to page results. The limit is specified in the request to limit the number of results returned. The token is specified in the response to signify that there are more results to get and in the request to get the next page of results.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	limit
protected java.lang.String	token

Constructor Summary

Constructors

Constructor and Description
ListRequest()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	generateHeaders() Returns the HTTP headers to send in this request, to be generated from other request properties immediately before sending.
int	getLimit() Gets the limit (page size) for this request.
java.lang.String	getToken() Gets the cursor token for this request, returned in the response to indicate there is another page of results and in the request to get the next page of results.
T	limit(int limit) Builder method for setLimit(int)
protected abstract T	me() Returns "this" in concrete implementation classes.
void	setLimit(int limit) Sets the limit (page size) for this request.
void	setToken(java.lang.String token) Sets the cursor token for this request, returned in the response to indicate there is another page of results and in the request to get the next page of results.
T	token(java.lang.String token) Builder method for setToken(String)

Methods inherited from class com.emc.atmos.api.request.Request

getMethod, getQuery, getServiceRelativePath, supports100Continue

Methods inherited from class java.lang.Object

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

Field Detail

limit

protected int limit

token

protected java.lang.String token

Constructor Detail

ListRequest

public ListRequest()

Method Detail

me

protected abstract T me()

Returns "this" in concrete implementation classes. Used in builder methods to be consistent throughout the hierarchy. For example, you can call new CreateObjectRequest().identifier(path).content(content).

Returns:

this

generateHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> generateHeaders()

Description copied from class: Request

Returns the HTTP headers to send in this request, to be generated from other request properties immediately before sending.

Specified by:

generateHeaders in class Request

limit

public T limit(int limit)

Builder method for setLimit(int)

token

public T token(java.lang.String token)

Builder method for setToken(String)

getLimit

public int getLimit()

Gets the limit (page size) for this request.

getToken

public java.lang.String getToken()

Gets the cursor token for this request, returned in the response to indicate there is another page of results and in the request to get the next page of results.

setLimit

public void setLimit(int limit)

Sets the limit (page size) for this request.

setToken

public void setToken(java.lang.String token)

Sets the cursor token for this request, returned in the response to indicate there is another page of results and in the request to get the next page of results. API implementations should set this value automatically if it is returned in the response, so you can check this value for null to see if you have received the entire list.