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

Class ResponseHeaderOverrides

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class ResponseHeaderOverrides
extends Object
implements Serializable

Container object for overriding headers on a GetObjectRequest or GeneratePresignedUrlRequest response. Response headers can be set on a GetObjectRequest or a GeneratePresignedUrlRequest in order to control particular HTTP headers in the service response from those service interfaces.

For example, a client could dynamically change the apparent Content-Disposition header of a single object, so that it appears to have a different file name for different callers. One client could be configured return the object with

 Content-Disposition: attachment; filename=FileName1.exe
 

while another could return that same object with headers

 Content-Disposition: attachment; filename=FileName2.pdf
 

See Also:

GetObjectRequest.setResponseHeaders(ResponseHeaderOverrides), GeneratePresignedUrlRequest.setResponseHeaders(ResponseHeaderOverrides), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESPONSE_HEADER_CACHE_CONTROL
static String	RESPONSE_HEADER_CONTENT_DISPOSITION
static String	RESPONSE_HEADER_CONTENT_ENCODING
static String	RESPONSE_HEADER_CONTENT_LANGUAGE
static String	RESPONSE_HEADER_CONTENT_TYPE
static String	RESPONSE_HEADER_EXPIRES

Constructor Summary

Constructors

Constructor and Description
ResponseHeaderOverrides()

Method Summary

Modifier and Type	Method and Description
String	getCacheControl() Returns the cache control response header override if it has been specified, or null otherwise.
String	getContentDisposition() Returns the content disposition response header override if it has been specified, or null otherwise.
String	getContentEncoding() Returns the content encoding response header override if it has been specified, or null otherwise.
String	getContentLanguage() Returns the content language response header override if it has been specified, or null otherwise.
String	getContentType() Returns the content type response header override if it has been specified, or null otherwise.
String	getExpires() Returns the expires response header override if it has been specified, or null otherwise.
void	setCacheControl(String cacheControl) Sets the cache control response header.
void	setContentDisposition(String contentDisposition) Sets the content disposition response header override.
void	setContentEncoding(String contentEncoding) Sets the content encoding response header override.
void	setContentLanguage(String contentLanguage) Sets the content language response header override
void	setContentType(String contentType) Sets the content type response header override.
void	setExpires(String expires) Sets the expires response header override.
ResponseHeaderOverrides	withCacheControl(String cacheControl) Sets the cache control response header.
ResponseHeaderOverrides	withContentDisposition(String contentDisposition) Sets the content disposition response header override.
ResponseHeaderOverrides	withContentEncoding(String contentEncoding) Sets the content encoding response header override.
ResponseHeaderOverrides	withContentLanguage(String contentLanguage) Sets the content language response header override
ResponseHeaderOverrides	withContentType(String contentType) Sets the content type response header override.
ResponseHeaderOverrides	withExpires(String expires) Sets the expires response header override.

Methods inherited from class java.lang.Object

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

Field Detail

RESPONSE_HEADER_CONTENT_TYPE

public static final String RESPONSE_HEADER_CONTENT_TYPE

See Also:

Constant Field Values

RESPONSE_HEADER_CONTENT_LANGUAGE

public static final String RESPONSE_HEADER_CONTENT_LANGUAGE

See Also:

Constant Field Values

RESPONSE_HEADER_EXPIRES

public static final String RESPONSE_HEADER_EXPIRES

See Also:

Constant Field Values

RESPONSE_HEADER_CACHE_CONTROL

public static final String RESPONSE_HEADER_CACHE_CONTROL

See Also:

Constant Field Values

RESPONSE_HEADER_CONTENT_DISPOSITION

public static final String RESPONSE_HEADER_CONTENT_DISPOSITION

See Also:

Constant Field Values

RESPONSE_HEADER_CONTENT_ENCODING

public static final String RESPONSE_HEADER_CONTENT_ENCODING

See Also:

Constant Field Values

Constructor Detail

ResponseHeaderOverrides

public ResponseHeaderOverrides()

Method Detail

getContentType

public String getContentType()

Returns the content type response header override if it has been specified, or null otherwise.

Returns:

Returns the content type response header override if it has been specified, or null otherwise.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_TYPE

setContentType

public void setContentType(String contentType)

Sets the content type response header override.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_TYPE

withContentType

public ResponseHeaderOverrides withContentType(String contentType)

Sets the content type response header override.

Returns:

This ResponseHeaderOverrides object for method chaining.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_TYPE

getContentLanguage

public String getContentLanguage()

Returns the content language response header override if it has been specified, or null otherwise.

Returns:

Returns the content language response header override if it has been specified, or null otherwise.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_LANGUAGE

setContentLanguage

public void setContentLanguage(String contentLanguage)

Sets the content language response header override

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_LANGUAGE

withContentLanguage

public ResponseHeaderOverrides withContentLanguage(String contentLanguage)

Sets the content language response header override

Returns:

This ResponseHeaderOverrides object for method chaining.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_LANGUAGE

getExpires

public String getExpires()

Returns the expires response header override if it has been specified, or null otherwise.

Returns:

Returns the expires response header override if it has been specified, or null otherwise.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_EXPIRES

setExpires

public void setExpires(String expires)

Sets the expires response header override.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_EXPIRES

withExpires

public ResponseHeaderOverrides withExpires(String expires)

Sets the expires response header override.

Returns:

This ResponseHeaderOverrides object for method chaining.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_EXPIRES

getCacheControl

public String getCacheControl()

Returns the cache control response header override if it has been specified, or null otherwise.

Returns:

Returns the cache control response header override if it has been specified, or null otherwise.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CACHE_CONTROL

setCacheControl

public void setCacheControl(String cacheControl)

Sets the cache control response header.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CACHE_CONTROL

withCacheControl

public ResponseHeaderOverrides withCacheControl(String cacheControl)

Sets the cache control response header.

Returns:

This ResponseHeaderOverrides object for method chaining.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CACHE_CONTROL

getContentDisposition

public String getContentDisposition()

Returns the content disposition response header override if it has been specified, or null otherwise.

Returns:

Returns the content disposition response header override if it has been specified, or null otherwise.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_DISPOSITION

setContentDisposition

public void setContentDisposition(String contentDisposition)

Sets the content disposition response header override.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_DISPOSITION

withContentDisposition

public ResponseHeaderOverrides withContentDisposition(String contentDisposition)

Sets the content disposition response header override.

Returns:

This ResponseHeaderOverrides object for method chaining.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_DISPOSITION

getContentEncoding

public String getContentEncoding()

Returns the content encoding response header override if it has been specified, or null otherwise.

Returns:

Returns the content encoding response header override if it has been specified, or null otherwise.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_ENCODING

setContentEncoding

public void setContentEncoding(String contentEncoding)

Sets the content encoding response header override.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_ENCODING

withContentEncoding

public ResponseHeaderOverrides withContentEncoding(String contentEncoding)

Sets the content encoding response header override.

Returns:

This ResponseHeaderOverrides object for method chaining.

See Also:

ResponseHeaderOverrides.RESPONSE_HEADER_CONTENT_ENCODING