com.aliyun.oss.model

Class ObjectMetadata

java.lang.Object

com.aliyun.oss.model.ObjectMetadata

Direct Known Subclasses:

SelectObjectMetadata

public class ObjectMetadata
extends Object

OSS Object's metadata. It has the user's custom metadata, as well as some standard http headers sent to OSS, such as Content-Length, ETag, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AES_256_SERVER_SIDE_ENCRYPTION
static String	KMS_SERVER_SIDE_ENCRYPTION
protected Map<String,Object>	metadata

Constructor Summary

Constructors

Constructor and Description
ObjectMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUserMetadata(String key, String value) Adds a new custom metadata.
String	getCacheControl() Gets the Cache-Control header.
String	getContentDisposition() Gets the Content-Disposition header.This is the standard http header.
String	getContentEncoding() Gets the Content-Encoding header which is to encode the object content.
long	getContentLength() Gets Content-Length header, which is the object content's size.
String	getContentMD5()
String	getContentType() Gets the Content-Type header to indicate the object content's type in MIME type format.
String	getETag() Gets the ETag of the object.
Date	getExpirationTime() Gets the Date value of the "Expires" header in Rfc822 format.
Date	getLastModified() Gets the value of Last-Modified header, which means the last modified time of the object.
String	getObjectRawRestore() Gets the restore status of the object of Archive type.
StorageClass	getObjectStorageClass() Gets the object's storage class, which is "standard", "IA" or "Archive".
String	getObjectType() Gets the object's storage type, which only supports "normal" and "appendable" for now.
String	getRawExpiresValue() Gets the string value of the "Expires" header in Rfc822 format.
Map<String,Object>	getRawMetadata() Gets the raw metadata (SDK internal usage only).
String	getRequestId() Gets the request Id.
Long	getServerCRC() Gets the service crc.
String	getServerSideDataEncryption() Gets the object's server side data encryption.
String	getServerSideEncryption() Gets the object's server side encryption.
String	getServerSideEncryptionKeyId() Gets the object's server side encryption key ID.
Map<String,String>	getUserMetadata() Gets the user's custom metadata.
String	getVersionId() Gets the version ID of the associated OSS object if available.
boolean	isRestoreCompleted() Gets the flag of completeness of restoring the Archive file.
void	removeHeader(String key) Removes the http header (SDK internal usage only).
void	setCacheControl(String cacheControl) Sets the Cache-Control header.
void	setContentDisposition(String disposition) Sets Content-Disposition header.
void	setContentEncoding(String encoding) Sets the Content-Encoding header which is to encode the object content.
void	setContentLength(long contentLength) Sets the Content-Length header to indicate the object's size.
void	setContentMD5(String contentMD5)
void	setContentType(String contentType) Sets the Content-Type header to indicate the object content's type in MIME type format.
void	setExpirationTime(Date expirationTime) Sets the "Expires" header.
void	setHeader(String key, Object value) Sets the http header (SDK internal usage only).
void	setLastModified(Date lastModified) Sets the value of Last-Modified header, which means the last modified time of the object.
void	setObjectAcl(CannedAccessControlList cannedAcl) Sets the object ACL.
void	setObjectTagging(Map<String,String> tags)
void	setServerSideDataEncryption(String serverSideDataEncryption) Sets the object's server side data encryption.
void	setServerSideEncryption(String serverSideEncryption) Sets the object's server side encryption.
void	setServerSideEncryptionKeyId(String serverSideEncryptionKeyId) Sets the object's server side encryption key ID.
void	setUserMetadata(Map<String,String> userMetadata) Sets the user's custom metadata.

Methods inherited from class java.lang.Object

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

Field Detail

metadata

protected Map<String,Object> metadata

AES_256_SERVER_SIDE_ENCRYPTION

public static final String AES_256_SERVER_SIDE_ENCRYPTION

See Also:

Constant Field Values

KMS_SERVER_SIDE_ENCRYPTION

public static final String KMS_SERVER_SIDE_ENCRYPTION

See Also:

Constant Field Values

Constructor Detail

ObjectMetadata

public ObjectMetadata()

Method Detail

getUserMetadata

public Map<String,String> getUserMetadata()

Gets the user's custom metadata.

The custom metadata would be appended with x-oss-meta- in the request to OSS. But here the caller should not use x-oss-meta- as the prefix for the keys of the Map instance returned. Meanwhile，the keys is case insenstive and all keys returned from OSS server is in lower case.

Returns:

User's custom metadata.

setUserMetadata

public void setUserMetadata(Map<String,String> userMetadata)

Sets the user's custom metadata.

Parameters:

userMetadata - The user's custom metadata.

setHeader

public void setHeader(String key,
             Object value)

Sets the http header (SDK internal usage only).

Parameters:

key - The key of header

value - The value of the key.

removeHeader

public void removeHeader(String key)

Removes the http header (SDK internal usage only).

Parameters:

key - The key of header.

addUserMetadata

public void addUserMetadata(String key,
                   String value)

Adds a new custom metadata.

Parameters:

key - Key of the header (not starting with x-oss-meta-)

value - The value for the key.

getLastModified

public Date getLastModified()

Gets the value of Last-Modified header, which means the last modified time of the object.

Returns:

Object's last modified time.

setLastModified

public void setLastModified(Date lastModified)

Sets the value of Last-Modified header, which means the last modified time of the object.

Parameters:

lastModified - Object's last modified time.

getExpirationTime

public Date getExpirationTime()
                       throws ParseException

Gets the Date value of the "Expires" header in Rfc822 format. If expiration is not set, then the value is null.

Returns:

Expires header's value in Rfc822.

Throws:

ParseException - The value is not in the Rfc822 format.

getRawExpiresValue

public String getRawExpiresValue()

Gets the string value of the "Expires" header in Rfc822 format. If expiration is not set, then the value is null.

Returns:

The string value of "Expires" header.

setExpirationTime

public void setExpirationTime(Date expirationTime)

Sets the "Expires" header.

Parameters:

expirationTime - Expiration time.

getContentLength

public long getContentLength()

Gets Content-Length header, which is the object content's size.

Returns:

The object content's size.

setContentLength

public void setContentLength(long contentLength)

Sets the Content-Length header to indicate the object's size. The correct Content-Length header is needed for a file upload.

Parameters:

contentLength - Object content size.

getContentType

public String getContentType()

Gets the Content-Type header to indicate the object content's type in MIME type format.

Returns:

The content-type header in MIME type format.

setContentType

public void setContentType(String contentType)

Sets the Content-Type header to indicate the object content's type in MIME type format.

Parameters:

contentType - The content-type header in MIME type format.

getContentMD5

public String getContentMD5()

setContentMD5

public void setContentMD5(String contentMD5)

getContentEncoding

public String getContentEncoding()

Gets the Content-Encoding header which is to encode the object content.

Returns:

Object content's encoding.

setContentEncoding

public void setContentEncoding(String encoding)

Sets the Content-Encoding header which is to encode the object content.

Parameters:

encoding - Object content's encoding.

getCacheControl

public String getCacheControl()

Gets the Cache-Control header. This is the standard http header.

Returns:

Cache-Control header.

setCacheControl

public void setCacheControl(String cacheControl)

Sets the Cache-Control header. This is the standard http header.

Parameters:

cacheControl - Cache-Control header.

getContentDisposition

public String getContentDisposition()

Gets the Content-Disposition header.This is the standard http header.

Returns:

Content-Disposition header.

setContentDisposition

public void setContentDisposition(String disposition)

Sets Content-Disposition header.

Parameters:

disposition - Content-Disposition header.

getETag

public String getETag()

Gets the ETag of the object. ETag is the 128bit MD5 signature in Hex.

getServerSideEncryption

public String getServerSideEncryption()

Gets the object's server side encryption.

Returns:

The server side encryption. Null means no encryption.

setServerSideEncryption

public void setServerSideEncryption(String serverSideEncryption)

Sets the object's server side encryption.

Parameters:

serverSideEncryption - The server side encryption.

getServerSideEncryptionKeyId

public String getServerSideEncryptionKeyId()

Gets the object's server side encryption key ID.

Returns:

The server side encryption key ID. Null means no encryption key ID.

setServerSideEncryptionKeyId

public void setServerSideEncryptionKeyId(String serverSideEncryptionKeyId)

Sets the object's server side encryption key ID.

Parameters:

serverSideEncryptionKeyId - The server side encryption key ID.

setServerSideDataEncryption

public void setServerSideDataEncryption(String serverSideDataEncryption)

Sets the object's server side data encryption.

Parameters:

serverSideDataEncryption - The server side data encryption.

getServerSideDataEncryption

public String getServerSideDataEncryption()

Gets the object's server side data encryption.

Returns:

The server side data encryption. Null means no data encryption.

getObjectType

public String getObjectType()

Gets the object's storage type, which only supports "normal" and "appendable" for now.

Returns:

Object's storage type.

setObjectAcl

public void setObjectAcl(CannedAccessControlList cannedAcl)

Sets the object ACL. For now it only supports default, private, public-read, public-read-write.

Parameters:

cannedAcl - Object ACL.

getRawMetadata

public Map<String,Object> getRawMetadata()

Gets the raw metadata (SDK internal usage only). The value returned is immutable.

Returns:

The raw metadata object.

getRequestId

public String getRequestId()

Gets the request Id.

Returns:

RequestId.

getVersionId

public String getVersionId()

Gets the version ID of the associated OSS object if available. Version IDs are only assigned to objects when an object is uploaded to an OSS bucket that has object versioning enabled.

Returns:

The version ID of the associated OSS object if available.

getServerCRC

public Long getServerCRC()

Gets the service crc.

Returns:

service crc.

getObjectStorageClass

public StorageClass getObjectStorageClass()

Gets the object's storage class, which is "standard", "IA" or "Archive".

Returns:

The storage class of the object.

getObjectRawRestore

public String getObjectRawRestore()

Gets the restore status of the object of Archive type.

Returns:

Object's restore status.

isRestoreCompleted

public boolean isRestoreCompleted()

Gets the flag of completeness of restoring the Archive file.

Returns:

The flag of completeness of restoring.

setObjectTagging

public void setObjectTagging(Map<String,String> tags)