com.emc.atmos.api.request

Class PutObjectRequest<T extends PutObjectRequest<T>>

java.lang.Object

com.emc.atmos.api.request.Request

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

com.emc.atmos.api.request.PutObjectRequest<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 ObjectRequest.me() to return "this". In abstract subclasses, return me() in builder methods.

All Implemented Interfaces:

ContentRequest

Direct Known Subclasses:

CreateObjectRequest, UpdateObjectRequest

public abstract class PutObjectRequest<T extends PutObjectRequest<T>>
extends ObjectRequest<T>
implements ContentRequest

Represents a write object request (create or update).

Field Summary

Fields

Modifier and Type	Field and Description
protected Acl	acl
protected java.lang.Object	content
protected long	contentLength
protected java.lang.String	contentType
protected java.lang.Long	retentionPeriod
protected java.lang.String	retentionPolicy
protected java.util.Map<java.lang.String,Metadata>	userMetadata
protected ChecksumValue	wsChecksum

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

identifier

Constructor Summary

Constructors

Constructor and Description
PutObjectRequest()

Method Summary

Modifier and Type	Method and Description
T	acl(Acl acl) Builder method for setAcl(com.emc.atmos.api.Acl)
T	content(java.lang.Object content) Builder method for setContent(Object)
T	contentLength(long contentLength) Builder method for setContentLength(long)
T	contentType(java.lang.String contentType) Builder method for setContentType(String)
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.
Acl	getAcl() Returns the ACL to assign to the object.
java.lang.Object	getContent() Returns the object content for this request.
long	getContentLength() Returns the content-length (byte size) for this request.
java.lang.String	getContentType() Returns the content-type for this request.
java.lang.Long	getRetentionPeriod() Note: this feature is only available on ECS 2.2+
java.lang.String	getRetentionPolicy() Note: this feature is only available on ECS 2.2+
ChecksumAlgorithm	getServerGeneratedChecksumAlgorithm() Gets the algorithm the Atmos server should use to generate a checksum for the content in this request.
java.util.Set<Metadata>	getUserMetadata() Returns the user metadata to assign to the object.
ChecksumValue	getWsChecksum() Returns the ws-checksum value to use in this request.
T	retentionPeriod(java.lang.Long retentionPeriod) Note: this feature is only available on ECS 2.2+
T	retentionPolicy(java.lang.String retentionPolicy) Note: this feature is only available on ECS 2.2+
T	serverGeneratedChecksumAlgorithm(ChecksumAlgorithm serverGeneratedChecksumAlgorithm) Builder method for setServerGeneratedChecksumAlgorithm(com.emc.atmos.api.ChecksumAlgorithm)
void	setAcl(Acl acl) Sets the ACL to assign to the object.
void	setContent(java.lang.Object content) Sets the object content for this request.
void	setContentLength(long contentLength) Sets the content-length (byte size) of the object content.
void	setContentType(java.lang.String contentType) Sets the content-type for this request.
void	setRetentionPeriod(java.lang.Long retentionPeriod) Note: this feature is only available on ECS 2.2+
void	setRetentionPolicy(java.lang.String retentionPolicy) Note: this feature is only available on ECS 2.2+
void	setServerGeneratedChecksumAlgorithm(ChecksumAlgorithm serverGeneratedChecksumAlgorithm) Sets the algorithm the Atmos server should use to generate a checksum for the content in this request.
void	setUserMetadata(java.util.Collection<Metadata> userMetadata) Sets the user metadata to assign to the object.
void	setWsChecksum(ChecksumValue wsChecksum) Sets the ws-checksum value to use for this request.
boolean	supports100Continue() Non-directory object writes support the Expect: 100-continue feature.
T	userMetadata(Metadata... userMetadata) Builder method for setUserMetadata(java.util.Collection)
T	wsChecksum(ChecksumValue wsChecksum) Builder method for setWsChecksum(com.emc.atmos.api.ChecksumValue)

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

getIdentifier, identifier, me, setIdentifier

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

getMethod, getQuery, getServiceRelativePath

Methods inherited from class java.lang.Object

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

Field Detail

content

protected java.lang.Object content

contentLength

protected long contentLength

contentType

protected java.lang.String contentType

acl

protected Acl acl

userMetadata

protected java.util.Map<java.lang.String,Metadata> userMetadata

retentionPeriod

protected java.lang.Long retentionPeriod

retentionPolicy

protected java.lang.String retentionPolicy

wsChecksum

protected ChecksumValue wsChecksum

Constructor Detail

PutObjectRequest

public PutObjectRequest()

Method Detail

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<T extends PutObjectRequest<T>>

supports100Continue

public boolean supports100Continue()

Non-directory object writes support the Expect: 100-continue feature.

Overrides:

supports100Continue in class Request

content

public T content(java.lang.Object content)

Builder method for setContent(Object)

contentLength

public T contentLength(long contentLength)

Builder method for setContentLength(long)

contentType

public T contentType(java.lang.String contentType)

Builder method for setContentType(String)

acl

public T acl(Acl acl)

Builder method for setAcl(com.emc.atmos.api.Acl)

userMetadata

public T userMetadata(Metadata... userMetadata)

Builder method for setUserMetadata(java.util.Collection)

retentionPeriod

public T retentionPeriod(java.lang.Long retentionPeriod)

Note: this feature is only available on ECS 2.2+

retentionPolicy

public T retentionPolicy(java.lang.String retentionPolicy)

Note: this feature is only available on ECS 2.2+

wsChecksum

public T wsChecksum(ChecksumValue wsChecksum)

Builder method for setWsChecksum(com.emc.atmos.api.ChecksumValue)

serverGeneratedChecksumAlgorithm

public T serverGeneratedChecksumAlgorithm(ChecksumAlgorithm serverGeneratedChecksumAlgorithm)

Builder method for setServerGeneratedChecksumAlgorithm(com.emc.atmos.api.ChecksumAlgorithm)

getContent

public java.lang.Object getContent()

Returns the object content for this request.

Specified by:

getContent in interface ContentRequest

getContentLength

public long getContentLength()

Returns the content-length (byte size) for this request.

Specified by:

getContentLength in interface ContentRequest

getContentType

public java.lang.String getContentType()

Returns the content-type for this request.

Specified by:

getContentType in interface ContentRequest

getAcl

public Acl getAcl()

Returns the ACL to assign to the object.

getUserMetadata

public java.util.Set<Metadata> getUserMetadata()

Returns the user metadata to assign to the object.

getRetentionPeriod

public java.lang.Long getRetentionPeriod()

Note: this feature is only available on ECS 2.2+

getRetentionPolicy

public java.lang.String getRetentionPolicy()

Note: this feature is only available on ECS 2.2+

getWsChecksum

public ChecksumValue getWsChecksum()

Returns the ws-checksum value to use in this request.

getServerGeneratedChecksumAlgorithm

public ChecksumAlgorithm getServerGeneratedChecksumAlgorithm()

Gets the algorithm the Atmos server should use to generate a checksum for the content in this request.

setContent

public void setContent(java.lang.Object content)

Sets the object content for this request.

setContentLength

public void setContentLength(long contentLength)

Sets the content-length (byte size) of the object content.

setContentType

public void setContentType(java.lang.String contentType)

Sets the content-type for this request.

setAcl

public void setAcl(Acl acl)

Sets the ACL to assign to the object.

setUserMetadata

public void setUserMetadata(java.util.Collection<Metadata> userMetadata)

Sets the user metadata to assign to the object. Note that this can only add or modify metadata on update operations. You must use AtmosApi.deleteUserMetadata(com.emc.atmos.api.ObjectIdentifier, String...) to remove metadata from an object.

setRetentionPeriod

public void setRetentionPeriod(java.lang.Long retentionPeriod)

Note: this feature is only available on ECS 2.2+

setRetentionPolicy

public void setRetentionPolicy(java.lang.String retentionPolicy)

Note: this feature is only available on ECS 2.2+

setWsChecksum

public void setWsChecksum(ChecksumValue wsChecksum)

Sets the ws-checksum value to use for this request. Note that although a RunningChecksum may be provided here, this is a ChecksumValue. Checksums are not automatically updated as they were in EsuApi. The value provided here must reflect what will be sent over the wire (you must manually update your checksums).

See Also:

ChecksumValue, RunningChecksum

setServerGeneratedChecksumAlgorithm

public void setServerGeneratedChecksumAlgorithm(ChecksumAlgorithm serverGeneratedChecksumAlgorithm)

Sets the algorithm the Atmos server should use to generate a checksum for the content in this request. Note that although this value will be returned in GET requests for the object, it is not maintained by the server and it only represents the checksum for the content in the last write request on the object. If the last write request was a range or if this flag was not set, the checksum is invalid. It is best to ignore the persisted value and only use this feature to verify each write request individually.