com.emc.atmos.api.request

Class ReadObjectRequest

java.lang.Object

com.emc.atmos.api.request.Request

com.emc.atmos.api.request.ObjectRequest<ReadObjectRequest>

com.emc.atmos.api.request.ReadObjectRequest

public class ReadObjectRequest
extends ObjectRequest<ReadObjectRequest>

Represents an Atmos read-object request.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Range>	ranges

Fields inherited from class com.emc.atmos.api.request.ObjectRequest

identifier

Constructor Summary

Constructors

Constructor and Description
ReadObjectRequest()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	generateHeaders(boolean encodeUtf8) Returns the HTTP headers to send in this request, to be generated from other request properties immediately before sending.
java.lang.String	getMethod() Returns the HTTP method this request will use.
java.util.List<Range>	getRanges() Returns the list of byte ranges to read from the target object.
java.lang.String	getServiceRelativePath() Returns the service-relative path of this request (i.e.
protected ReadObjectRequest	me() Returns "this" in concrete implementation classes.
ReadObjectRequest	ranges(Range... range) Builder method for setRanges(java.util.List)
void	setRanges(java.util.List<Range> ranges) Sets the list of byte ranges to read from the target object.

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

getIdentifier, identifier, setIdentifier

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

getQuery, supports100Continue

Methods inherited from class java.lang.Object

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

Field Detail

ranges

protected java.util.List<Range> ranges

Constructor Detail

ReadObjectRequest

public ReadObjectRequest()

Method Detail

getServiceRelativePath

public java.lang.String getServiceRelativePath()

Description copied from class: Request

Returns the service-relative path of this request (i.e. "objects/{identifier}" for read-object).

Specified by:

getServiceRelativePath in class Request

getMethod

public java.lang.String getMethod()

Description copied from class: Request

Returns the HTTP method this request will use.

Specified by:

getMethod in class Request

generateHeaders

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

Description copied from class: Request

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

Overrides:

generateHeaders in class ObjectRequest<ReadObjectRequest>

me

protected ReadObjectRequest me()

Description copied from class: ObjectRequest

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).

Specified by:

me in class ObjectRequest<ReadObjectRequest>

Returns:

this

ranges

public ReadObjectRequest ranges(Range... range)

Builder method for setRanges(java.util.List)

getRanges

public java.util.List<Range> getRanges()

Returns the list of byte ranges to read from the target object.

setRanges

public void setRanges(java.util.List<Range> ranges)

Sets the list of byte ranges to read from the target object.