org.javaswift.joss.client.core

Class AbstractObjectStoreEntity<I extends AbstractInformation>

java.lang.Object

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

All Implemented Interfaces:

ObjectStoreEntity

Direct Known Subclasses:

AbstractAccount, AbstractContainer, AbstractStoredObject

public abstract class AbstractObjectStoreEntity<I extends AbstractInformation>
extends java.lang.Object
implements ObjectStoreEntity

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	ALLOW_CACHING
protected I	info
protected boolean	staleHeaders

Constructor Summary

Constructors

Constructor and Description
AbstractObjectStoreEntity(boolean allowCaching)

Method Summary

Modifier and Type	Method and Description
protected void	checkForInfo()
protected void	checkForInfo(boolean readHeader, boolean allowErrorLog)
protected void	checkForInfoAndAllowHeaderSet()
protected void	checkForInfoDisallowErrorLog()
protected abstract Metadata	createMetadataEntry(java.lang.String name, java.lang.String value)
boolean	exists()
protected abstract void	getInfo(boolean allowErrorLog)
java.util.Map<java.lang.String,java.lang.Object>	getMetadata() Gets the metadata headers
java.lang.Object	getMetadata(java.lang.String key) Returns a single value of the designated key, or null if it does not exist.
java.lang.String	getPath() Returns the path to be appended to the host
abstract java.lang.String	getPathForEntity()
void	invalidate()
boolean	isAllowCaching()
boolean	isInfoRetrieved() Included for backwards portability reasons
boolean	isStale(boolean readHeader)
void	reload()
void	removeAndDoNotSaveMetadata(java.lang.String key) Removes a single metadata field, but does not place a call to the server to save.
void	removeAndSaveMetadata(java.lang.String key) Removes a single metadata field and immediately places a call to the server to save
void	saveMetadata() Places a call to the server to save all metadata, previously set with setMetadata excluding the save option
protected abstract void	saveSpecificMetadata()
void	setAndDoNotSaveMetadata(java.lang.String key, java.lang.Object value) Sets a single metadata field, but does not place a call to the server to save.
void	setAndSaveMetadata(java.lang.String key, java.lang.Object value) Sets a single metadata field and immediately places a call to the server to save
protected void	setInfoRetrieved()
void	setMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata) Sets the metadata headers

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_CACHING

protected static final boolean ALLOW_CACHING

See Also:

Constant Field Values

info

protected I extends AbstractInformation info

staleHeaders

protected boolean staleHeaders

Constructor Detail

AbstractObjectStoreEntity

public AbstractObjectStoreEntity(boolean allowCaching)

Method Detail

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata)

Description copied from interface: ObjectStoreEntity

Sets the metadata headers

Specified by:

setMetadata in interface ObjectStoreEntity

Parameters:

metadata - contains all metadata name/value pairs that must be set

setAndSaveMetadata

public void setAndSaveMetadata(java.lang.String key,
                               java.lang.Object value)

Description copied from interface: ObjectStoreEntity

Sets a single metadata field and immediately places a call to the server to save

Specified by:

setAndSaveMetadata in interface ObjectStoreEntity

Parameters:

key - metadata field to add

value - value of the metadata field

setAndDoNotSaveMetadata

public void setAndDoNotSaveMetadata(java.lang.String key,
                                    java.lang.Object value)

Description copied from interface: ObjectStoreEntity

Sets a single metadata field, but does not place a call to the server to save. This must be explicitly called with saveMetadata.

Specified by:

setAndDoNotSaveMetadata in interface ObjectStoreEntity

Parameters:

key - metadata field to add

value - value of the metadata field

removeAndSaveMetadata

public void removeAndSaveMetadata(java.lang.String key)

Description copied from interface: ObjectStoreEntity

Removes a single metadata field and immediately places a call to the server to save

Specified by:

removeAndSaveMetadata in interface ObjectStoreEntity

Parameters:

key - metadata field to remove

removeAndDoNotSaveMetadata

public void removeAndDoNotSaveMetadata(java.lang.String key)

Description copied from interface: ObjectStoreEntity

Removes a single metadata field, but does not place a call to the server to save. This must be explicitly called with saveMetadata.

Specified by:

removeAndDoNotSaveMetadata in interface ObjectStoreEntity

Parameters:

key - metadata field to remove

createMetadataEntry

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

saveMetadata

public void saveMetadata()

Description copied from interface: ObjectStoreEntity

Places a call to the server to save all metadata, previously set with setMetadata excluding the save option

Specified by:

saveMetadata in interface ObjectStoreEntity

saveSpecificMetadata

protected abstract void saveSpecificMetadata()

getMetadata

public java.lang.Object getMetadata(java.lang.String key)

Description copied from interface: ObjectStoreEntity

Returns a single value of the designated key, or null if it does not exist.

Specified by:

getMetadata in interface ObjectStoreEntity

Parameters:

key - the key of the key/value pair

Returns:

the value belonging to the key

getMetadata

public java.util.Map<java.lang.String,java.lang.Object> getMetadata()

Description copied from interface: ObjectStoreEntity

Gets the metadata headers

Specified by:

getMetadata in interface ObjectStoreEntity

Returns:

the metadata on the entity

checkForInfoAndAllowHeaderSet

protected void checkForInfoAndAllowHeaderSet()

checkForInfo

protected void checkForInfo()

checkForInfoDisallowErrorLog

protected void checkForInfoDisallowErrorLog()

checkForInfo

protected void checkForInfo(boolean readHeader,
                            boolean allowErrorLog)

setInfoRetrieved

protected void setInfoRetrieved()

exists

public boolean exists()

invalidate

public void invalidate()

isStale

public boolean isStale(boolean readHeader)

isAllowCaching

public boolean isAllowCaching()

reload

public void reload()

isInfoRetrieved

public boolean isInfoRetrieved()

Included for backwards portability reasons

Returns:

true if the metadata has been retrieved

getPath

public java.lang.String getPath()

Description copied from interface: ObjectStoreEntity

Returns the path to be appended to the host

Specified by:

getPath in interface ObjectStoreEntity

Returns:

the path to append to the host

getPathForEntity

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

Throws:

java.io.UnsupportedEncodingException

getInfo

protected abstract void getInfo(boolean allowErrorLog)