com.ibm.cloud.objectstorage.services.s3.model

Class PresignedUrlUploadRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.PresignedUrlUploadRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, S3DataSource, Serializable, Cloneable

public class PresignedUrlUploadRequest
extends AmazonWebServiceRequest
implements S3DataSource, Serializable

Request class to upload a object to S3 using presigned urls. Upload content can be provided through a file or input stream. The behavior is similar to using PutObjectRequest. Depending on whether a file or input stream is being uploaded, this request has slightly different behavior.

When uploading a file:

• The client automatically computes a checksum of the file. Amazon S3 uses checksums to validate the data in each file.
• Using the file extension, Amazon S3 attempts to determine the correct content type and content disposition to use for the object with some exceptions. See below.
• If the given presigned url is created using SigV2 signer and content type is not provided, then SDK will not attempt to determine the content type and instead sends an empty string for content type. This is because content type is signed header in SigV2 and so the content type can only be sent if it is used in creating presigned url.
• If the given presigned url is created using SigV4 signer, then SDK attempts to determine the correct content type and sends it with the request if not provided. Note that this only works if you have not used content type while creating the presigned url. If you have used content type while creating the url, then you should set the same content type while making this API call through PresignedUrlUploadRequest.setMetadata(ObjectMetadata) or AmazonWebServiceRequest.putCustomRequestHeader(String, String)

Amazon S3 is a distributed system. If Amazon S3 receives multiple write requests for the same object nearly simultaneously, all of the objects might be stored. However, only one object will obtain the key.

If custom headers are used in generating the url, you can set them through AmazonWebServiceRequest.putCustomRequestHeader(String, String) method. If any signed headers or parameters are missing from the request, a Signature mismatch error will be thrown from S3. Ensure you set all the custom headers/parameters that are used for creating the presigned url.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cloud.objectstorage.services.s3.model.S3DataSource

S3DataSource.Utils

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PresignedUrlUploadRequest(URL presignedUrl)

Method Summary

Modifier and Type	Method and Description
File	getFile()
HttpMethodName	getHttpMethodName()
InputStream	getInputStream()
ObjectMetadata	getMetadata() Gets the optional metadata instructing Amazon S3 how to handle the uploaded data (e.g.
URL	getPresignedUrl()
void	setFile(File file)
void	setHttpMethodName(HttpMethodName httpMethodName)
void	setInputStream(InputStream inputStream)
void	setMetadata(ObjectMetadata metadata) Sets the optional metadata instructing Amazon S3 how to handle the uploaded data (e.g.
void	setPresignedUrl(URL presignedUrl)
PresignedUrlUploadRequest	withFile(File file)
PresignedUrlUploadRequest	withHttpMethodName(HttpMethodName httpMethodName)
PresignedUrlUploadRequest	withInputStream(InputStream inputStream)
PresignedUrlUploadRequest	withMetadata(ObjectMetadata metadata) Sets the optional metadata instructing Amazon S3 how to handle the uploaded data (e.g.
PresignedUrlUploadRequest	withPresignedUrl(URL presignedUrl)

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

addHandlerContext, clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

PresignedUrlUploadRequest

public PresignedUrlUploadRequest(URL presignedUrl)

Method Detail

getPresignedUrl

public URL getPresignedUrl()

Returns:

The presigned url to which the request will be sent

setPresignedUrl

public void setPresignedUrl(URL presignedUrl)

Parameters:

presignedUrl - sets the presigned url to send the request to

withPresignedUrl

public PresignedUrlUploadRequest withPresignedUrl(URL presignedUrl)

Parameters:

presignedUrl - sets the presigned url to send the request to

Returns:

This object for method chaining

getHttpMethodName

public HttpMethodName getHttpMethodName()

Returns:

The HTTP method (PUT, POST) to be used in this request. The default value is PUT.

setHttpMethodName

public void setHttpMethodName(HttpMethodName httpMethodName)

Parameters:

httpMethodName - Sets the HTTP method (PUT, POST) to be used in this request. The default value is PUT.

withHttpMethodName

public PresignedUrlUploadRequest withHttpMethodName(HttpMethodName httpMethodName)

Parameters:

httpMethodName - Sets the HTTP method (PUT, POST) to be used in this request. The default value is PUT.

Returns:

This object for method chaining

getFile

public File getFile()

Specified by:

getFile in interface S3DataSource

Returns:

the file to upload

setFile

public void setFile(File file)

Specified by:

setFile in interface S3DataSource

Parameters:

file - Sets the file to upload

withFile

public PresignedUrlUploadRequest withFile(File file)

Parameters:

file - Sets the file to upload

Returns:

This object for method chaining

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface S3DataSource

Returns:

the data stream used for the upload

setInputStream

public void setInputStream(InputStream inputStream)

Specified by:

setInputStream in interface S3DataSource

Parameters:

inputStream - the data stream to upload

withInputStream

public PresignedUrlUploadRequest withInputStream(InputStream inputStream)

Parameters:

inputStream - the data stream to upload

Returns:

This object for method chaining

getMetadata

public ObjectMetadata getMetadata()

Gets the optional metadata instructing Amazon S3 how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.).

If uploading from an input stream, always specify metadata with the content size set. Otherwise the contents of the input stream have to be buffered in memory before being sent to Amazon S3. This can cause very negative performance impacts.

Returns:

The optional metadata instructing Amazon S3 how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.).

setMetadata

public void setMetadata(ObjectMetadata metadata)

Sets the optional metadata instructing Amazon S3 how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.).

If uploading from an input stream, always specify metadata with the content size set. Otherwise the contents of the input stream have to be buffered in memory before being sent to Amazon S3. This can cause very negative performance impacts.

Parameters:

metadata - The optional metadata instructing Amazon S3 how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.).

withMetadata

public PresignedUrlUploadRequest withMetadata(ObjectMetadata metadata)

Sets the optional metadata instructing Amazon S3 how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.).

If uploading from an input stream, always specify metadata with the content size set. Otherwise the contents of the input stream have to be buffered in memory before being sent to Amazon S3. This can cause very negative performance impacts.

Parameters:

metadata - The optional metadata instructing Amazon S3 how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.).

Returns:

This object for method chaining