org.javaswift.joss.client.core

Class AbstractStoredObject

java.lang.Object

org.javaswift.joss.client.core.AbstractObjectStoreEntity<ObjectInformation>

org.javaswift.joss.client.core.AbstractStoredObject

All Implemented Interfaces:

java.lang.Comparable<DirectoryOrObject>, DirectoryOrObject, ListSubject, ObjectStoreEntity, StoredObject

Direct Known Subclasses:

StoredObjectImpl, StoredObjectMock

public abstract class AbstractStoredObject
extends AbstractObjectStoreEntity<ObjectInformation>
implements StoredObject

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name

Fields inherited from class org.javaswift.joss.client.core.AbstractObjectStoreEntity

ALLOW_CACHING, info, staleHeaders

Constructor Summary

Constructors

Constructor and Description
AbstractStoredObject(Container container, java.lang.String name, boolean allowCaching)

Method Summary

Modifier and Type	Method and Description
int	compareTo(DirectoryOrObject o)
void	copyObject(Container targetContainer, StoredObject targetObject) Copies the content of an object to another object.
protected Metadata	createMetadataEntry(java.lang.String name, java.lang.String value)
void	delete() Deletes an object in a container.
void	directlyUploadObject(UploadInstructions uploadInstructions)
byte[]	downloadObject() Fetches the object in a Container in a byte array.
byte[]	downloadObject(DownloadInstructions downloadInstructions) See documentation of StoredObject.downloadObject().
void	downloadObject(java.io.File targetFile) Reads the object and writes it to a file.
void	downloadObject(java.io.File targetFile, DownloadInstructions downloadInstructions) See documentation of StoredObject.downloadObject(java.io.File).
java.io.InputStream	downloadObjectAsInputStream() Fetches the object in a Container in an InputStream.
java.io.InputStream	downloadObjectAsInputStream(DownloadInstructions downloadInstructions) See documentation of StoredObject.downloadObjectAsInputStream().
boolean	equals(java.lang.Object o)
protected Account	getAccount()
Directory	getAsDirectory()
StoredObject	getAsObject()
java.lang.String	getBareName()
Container	getContainer()
long	getContentLength() The number of the bytes used by the StoredObject.
java.lang.String	getContentType() The content type of the StoredObject.
java.lang.String	getDeleteAt() The date when the object will be deleted.
java.util.Date	getDeleteAtAsDate() The date when the object will be deleted.
java.lang.String	getEtag() The etag (or hash) of the StoredObject.
protected void	getInfo(boolean allowErrorLog)
java.lang.String	getLastModified() The last modified date of the StoredObject.
java.util.Date	getLastModifiedAsDate() The last modified date of the StoredObject.
java.lang.String	getManifest() The manifest of the StoredObject (relevant for large objects that are segmented).
java.lang.String	getName()
java.lang.String	getPathForEntity()
java.lang.String	getPrivateURL() Returns the private URL through which the resource can be viewed
java.lang.String	getPublicURL() Returns the URL through which the resource can be viewed
java.lang.String	getTempGetUrl(long durationInSeconds) Returns a temporary GET URL to an Object.
java.lang.String	getTempPutUrl(long durationInSeconds) Returns a temporary POST URL to an Object, allowing one to directly upload content to the ObjectStore.
protected java.lang.String	getTempUrl(java.lang.String method, long durationInSeconds)
java.lang.String	getURL() This call checks the container privacy before deciding whether to use the configured / private host or the default ObjectStore host.
int	hashCode()
boolean	isDirectory()
boolean	isObject()
void	metadataSetFromHeaders() Declares to the ListSubject that a number of fields have been read from the list operation and therefore do not have to be fetched individually, unless caching is turned off.
protected void	saveSpecificMetadata()
void	setContentLength(long contentLength)
StoredObject	setContentType(java.lang.String contentType) Explicitly sets the content type of an object.
void	setContentTypeWithoutSaving(java.lang.String contentType)
StoredObject	setDeleteAfter(long seconds) Schedules the object to be deleted after a fixed period of x seconds
StoredObject	setDeleteAfter(java.lang.Long seconds) Schedules the object to be deleted after a fixed period of x seconds
StoredObject	setDeleteAt(java.util.Date date) Schedules the object to be deleted at a fixed date.
void	setEtag(java.lang.String etag)
void	setLastModified(java.util.Date date)
void	setLastModified(java.lang.String date)
void	uploadObject(byte[] fileToUpload) Uploads a byte array object to a location designated by the Container and the object.
void	uploadObject(java.io.File fileToUpload) Uploads a file from a designated location to a location designated by the Container and the object.
void	uploadObject(java.io.InputStream inputStream) Uploads a byte array object to a location designated by the Container and the object.
void	uploadObject(UploadInstructions uploadInstructions) Uploads a byte array object to a location designated by the Container and the object.
void	uploadObjectAsSegments(UploadInstructions uploadInstructions)
boolean	verifyTempUrl(java.lang.String method, java.lang.String signature, long expiry) Creates a hash using the server's hash password and compares it to the signature.

Methods inherited from class org.javaswift.joss.client.core.AbstractObjectStoreEntity

checkForInfo, checkForInfo, checkForInfoAndAllowHeaderSet, checkForInfoDisallowErrorLog, exists, getMetadata, getMetadata, getPath, invalidate, isAllowCaching, isInfoRetrieved, isStale, reload, removeAndDoNotSaveMetadata, removeAndSaveMetadata, saveMetadata, setAndDoNotSaveMetadata, setAndSaveMetadata, setInfoRetrieved, setMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javaswift.joss.model.StoredObject

exists, getPath, isInfoRetrieved, reload

Methods inherited from interface org.javaswift.joss.model.ObjectStoreEntity

getMetadata, getMetadata, removeAndDoNotSaveMetadata, removeAndSaveMetadata, saveMetadata, setAndDoNotSaveMetadata, setAndSaveMetadata, setMetadata

Field Detail

name

protected java.lang.String name

Constructor Detail

AbstractStoredObject

public AbstractStoredObject(Container container,
                            java.lang.String name,
                            boolean allowCaching)

Method Detail

metadataSetFromHeaders

public void metadataSetFromHeaders()

Description copied from interface: ListSubject

Declares to the ListSubject that a number of fields have been read from the list operation and therefore do not have to be fetched individually, unless caching is turned off.

Specified by:

metadataSetFromHeaders in interface ListSubject

getLastModifiedAsDate

public java.util.Date getLastModifiedAsDate()

Description copied from interface: StoredObject

The last modified date of the StoredObject. If the Container was read by Container.list, this value will not be refetched from the server, unless caching is disabled.

Specified by:

getLastModifiedAsDate in interface StoredObject

Returns:

last modified date

getLastModified

public java.lang.String getLastModified()

Description copied from interface: StoredObject

The last modified date of the StoredObject. If the Container was read by Container.list, this value will not be refetched from the server, unless caching is disabled.

Specified by:

getLastModified in interface StoredObject

Returns:

last modified date

getEtag

public java.lang.String getEtag()

Description copied from interface: StoredObject

The etag (or hash) of the StoredObject. If the Container was read by Container.list, this value will not be refetched from the server, unless caching is disabled.

Specified by:

getEtag in interface StoredObject

Returns:

etag or hash of the StoredObject

getManifest

public java.lang.String getManifest()

Description copied from interface: StoredObject

The manifest of the StoredObject (relevant for large objects that are segmented). If the Container was read by Container.list, this value will not be refetched from the server, unless caching is disabled.

Specified by:

getManifest in interface StoredObject

Returns:

manifest of the StoredObject, or null if the object has no manifest

getContentLength

public long getContentLength()

Description copied from interface: StoredObject

The number of the bytes used by the StoredObject. If the Container was read by Container.list, this value will not be refetched from the server, unless caching is disabled.

Specified by:

getContentLength in interface StoredObject

Returns:

number of bytes used

getContentType

public java.lang.String getContentType()

Description copied from interface: StoredObject

The content type of the StoredObject. If the Container was read by Container.list, this value will not be refetched from the server, unless caching is disabled.

Specified by:

getContentType in interface StoredObject

Returns:

content type

getDeleteAtAsDate

public java.util.Date getDeleteAtAsDate()

Description copied from interface: StoredObject

The date when the object will be deleted. Note that this value is never passed in Container.list and therefore always costs an extra HTTP call to the server.

Specified by:

getDeleteAtAsDate in interface StoredObject

Returns:

date when the StoredObject will be deleted (as a java.util.Date)

getDeleteAt

public java.lang.String getDeleteAt()

Description copied from interface: StoredObject

The date when the object will be deleted. Note that this value is never passed in Container.list and therefore always costs an extra HTTP call to the server.

Specified by:

getDeleteAt in interface StoredObject

Returns:

date when the StoredObject will be deleted (as a String)

getName

public java.lang.String getName()

Specified by:

getName in interface ListSubject

getContainer

public Container getContainer()

getURL

public java.lang.String getURL()

Description copied from interface: StoredObject

This call checks the container privacy before deciding whether to use the configured / private host or the default ObjectStore host. NOTE: this call needs to know the container's privacy settings and therefore, if it did not do so already, will make a HEAD call to fetch the container's metadata.

Specified by:

getURL in interface StoredObject

Returns:

the URL of the resource

getPublicURL

public java.lang.String getPublicURL()

Description copied from interface: StoredObject

Returns the URL through which the resource can be viewed

Specified by:

getPublicURL in interface StoredObject

Returns:

the URL of the resource

getPrivateURL

public java.lang.String getPrivateURL()

Description copied from interface: StoredObject

Returns the private URL through which the resource can be viewed

Specified by:

getPrivateURL in interface StoredObject

Returns:

the private URL of the resource

getPathForEntity

public java.lang.String getPathForEntity()
                                  throws java.io.UnsupportedEncodingException

Specified by:

getPathForEntity in class AbstractObjectStoreEntity<ObjectInformation>

Throws:

java.io.UnsupportedEncodingException

setLastModified

public void setLastModified(java.util.Date date)

Specified by:

setLastModified in interface StoredObject

setLastModified

public void setLastModified(java.lang.String date)

Specified by:

setLastModified in interface StoredObject

setEtag

public void setEtag(java.lang.String etag)

Specified by:

setEtag in interface StoredObject

setContentLength

public void setContentLength(long contentLength)

Specified by:

setContentLength in interface StoredObject

setContentTypeWithoutSaving

public void setContentTypeWithoutSaving(java.lang.String contentType)

Specified by:

setContentTypeWithoutSaving in interface StoredObject

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

uploadObject

public void uploadObject(UploadInstructions uploadInstructions)

Description copied from interface: StoredObject

Uploads a byte array object to a location designated by the Container and the object.

Specified by:

uploadObject in interface StoredObject

Parameters:

uploadInstructions - not only the content to be uploaded, but also additional headers that need to be set

uploadObjectAsSegments

public void uploadObjectAsSegments(UploadInstructions uploadInstructions)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(DirectoryOrObject o)

Specified by:

compareTo in interface java.lang.Comparable<DirectoryOrObject>

createMetadataEntry

protected Metadata createMetadataEntry(java.lang.String name,
                                       java.lang.String value)

Specified by:

createMetadataEntry in class AbstractObjectStoreEntity<ObjectInformation>

downloadObjectAsInputStream

public java.io.InputStream downloadObjectAsInputStream()

Description copied from interface: StoredObject

Fetches the object in a Container in an InputStream. Note that for passing the information on, the content-type is useful. This information can be found by fetching the object information. BE AWARE that the original InputStream must be closed after usage, which can be accomplished by calling close on the InputStream (which consumes the entire original response).

Specified by:

downloadObjectAsInputStream in interface StoredObject

Returns:

the object in an InputStreamWrapper (containing the input stream)

downloadObjectAsInputStream

public java.io.InputStream downloadObjectAsInputStream(DownloadInstructions downloadInstructions)

Description copied from interface: StoredObject

See documentation of StoredObject.downloadObjectAsInputStream(). This method also accepts the download instructions, which can be used among others to set the "Range" and "If-*" headers.

Specified by:

downloadObjectAsInputStream in interface StoredObject

Parameters:

downloadInstructions - the instructions for downloading the object

Returns:

the object in an InputStreamWrapper (containing the input stream)

downloadObject

public byte[] downloadObject()

Description copied from interface: StoredObject

Fetches the object in a Container in a byte array. Note that for passing the information on, the content-type is useful. This information can be found by fetching the object information.

Specified by:

downloadObject in interface StoredObject

Returns:

the object in a byte array

downloadObject

public byte[] downloadObject(DownloadInstructions downloadInstructions)

Description copied from interface: StoredObject

See documentation of StoredObject.downloadObject(). This method also accepts the download instructions, which can be used among others to set the "Range" and "If-*" headers.

Specified by:

downloadObject in interface StoredObject

Parameters:

downloadInstructions - the instructions for downloading the object

Returns:

the object in a byte array

downloadObject

public void downloadObject(java.io.File targetFile)

Description copied from interface: StoredObject

Reads the object and writes it to a file.

Specified by:

downloadObject in interface StoredObject

Parameters:

targetFile - the file to write the object to

downloadObject

public void downloadObject(java.io.File targetFile,
                           DownloadInstructions downloadInstructions)

Description copied from interface: StoredObject

See documentation of StoredObject.downloadObject(java.io.File). This method also accepts the download instructions, which can be used among others to set the "Range" and "If-*" headers.

Specified by:

downloadObject in interface StoredObject

Parameters:

targetFile - the file to write the object to

downloadInstructions - the instructions for downloading the object

directlyUploadObject

public void directlyUploadObject(UploadInstructions uploadInstructions)

uploadObject

public void uploadObject(java.io.InputStream inputStream)

Description copied from interface: StoredObject

Uploads a byte array object to a location designated by the Container and the object.

Specified by:

uploadObject in interface StoredObject

Parameters:

inputStream - the actual content that must be uploaded to the object, in InputStream format

uploadObject

public void uploadObject(byte[] fileToUpload)

Description copied from interface: StoredObject

Uploads a byte array object to a location designated by the Container and the object.

Specified by:

uploadObject in interface StoredObject

Parameters:

fileToUpload - the actual content that must be uploaded to the object

uploadObject

public void uploadObject(java.io.File fileToUpload)

Description copied from interface: StoredObject

Uploads a file from a designated location to a location designated by the Container and the object.

Specified by:

uploadObject in interface StoredObject

Parameters:

fileToUpload - the file containing the content that must be uploaded to the object

delete

public void delete()

Description copied from interface: StoredObject

Deletes an object in a container. In combination with copyObject, this is effectively the "Best Practice' move method.

Specified by:

delete in interface StoredObject

copyObject

public void copyObject(Container targetContainer,
                       StoredObject targetObject)

Description copied from interface: StoredObject

Copies the content of an object to another object. In combination with deleteObject, this is effectively the "Best Practice" move method.

Specified by:

copyObject in interface StoredObject

Parameters:

targetContainer - the owning Container of the target location of the copy

targetObject - the object location where the copy must be placed

setContentType

public StoredObject setContentType(java.lang.String contentType)

Description copied from interface: StoredObject

Explicitly sets the content type of an object. This can be useful, for example when you have content-sniffers in the application that need to advise the object store (which uses a simple file extension matching instead of content-sniffing) as to the real nature of the uploaded file.

Specified by:

setContentType in interface StoredObject

Parameters:

contentType - the content type of the object

Returns:

this

setDeleteAfter

public StoredObject setDeleteAfter(java.lang.Long seconds)

Description copied from interface: StoredObject

Schedules the object to be deleted after a fixed period of x seconds

Specified by:

setDeleteAfter in interface StoredObject

Parameters:

seconds - the number of seconds to wait before deleting the content. If seconds is null delete after header will be cleared

Returns:

this

setDeleteAfter

public StoredObject setDeleteAfter(long seconds)

Description copied from interface: StoredObject

Schedules the object to be deleted after a fixed period of x seconds

Specified by:

setDeleteAfter in interface StoredObject

Parameters:

seconds - the number of seconds to wait before deleting the content

Returns:

this

setDeleteAt

public StoredObject setDeleteAt(java.util.Date date)

Description copied from interface: StoredObject

Schedules the object to be deleted at a fixed date. Be careful using this method, since the server's date may be different from yours.

Specified by:

setDeleteAt in interface StoredObject

Parameters:

date - the date at which to delete the content. If date is null delete at header will be cleared

Returns:

this

getAccount

protected Account getAccount()

saveSpecificMetadata

protected void saveSpecificMetadata()

Specified by:

saveSpecificMetadata in class AbstractObjectStoreEntity<ObjectInformation>

getInfo

protected void getInfo(boolean allowErrorLog)

Specified by:

getInfo in class AbstractObjectStoreEntity<ObjectInformation>

getTempGetUrl

public java.lang.String getTempGetUrl(long durationInSeconds)

Description copied from interface: StoredObject

Returns a temporary GET URL to an Object. Note that for this method to work Account.saveHashPassword must have been set.

Specified by:

getTempGetUrl in interface StoredObject

Parameters:

durationInSeconds - number of seconds for the temporary URL to be valid

Returns:

temporary GET URL to the object

getTempPutUrl

public java.lang.String getTempPutUrl(long durationInSeconds)

Description copied from interface: StoredObject

Returns a temporary POST URL to an Object, allowing one to directly upload content to the ObjectStore. The object does not yet have to exist for this method to be invoked. Note that for this method to work Account.saveHashPassword must have been set.

Specified by:

getTempPutUrl in interface StoredObject

Parameters:

durationInSeconds - number of seconds for the temporary URL to be valid

Returns:

temporary POST URL to the object

getTempUrl

protected java.lang.String getTempUrl(java.lang.String method,
                                      long durationInSeconds)

verifyTempUrl

public boolean verifyTempUrl(java.lang.String method,
                             java.lang.String signature,
                             long expiry)

Description copied from interface: StoredObject

Creates a hash using the server's hash password and compares it to the signature. If right, expiry will be checked against the server time. If all matches, a go is given. This method is useful for supporting TempURLs in a mock context.

Specified by:

verifyTempUrl in interface StoredObject

Parameters:

method - in REST terms, the command to execute

signature - the password to use for creating the hash

expiry - the expiration time of the temporary URL

Returns:

true if the TempURL is valid, false if not

isObject

public boolean isObject()

Specified by:

isObject in interface DirectoryOrObject

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface DirectoryOrObject

getAsDirectory

public Directory getAsDirectory()

Specified by:

getAsDirectory in interface DirectoryOrObject

getAsObject

public StoredObject getAsObject()

Specified by:

getAsObject in interface DirectoryOrObject

getBareName

public java.lang.String getBareName()

Specified by:

getBareName in interface DirectoryOrObject