Package org.jets3t.service.model
Class BaseStorageItem
- java.lang.Object
-
- org.jets3t.service.model.BaseStorageItem
-
- Direct Known Subclasses:
StorageBucket
,StorageObject
public abstract class BaseStorageItem extends Object
Base class to represent storage items that can contain metadata: both objects and buckets.- Author:
- James Murty
-
-
Field Summary
Fields Modifier and Type Field Description static String
METADATA_HEADER_CONTENT_DISPOSITION
static String
METADATA_HEADER_CONTENT_ENCODING
static String
METADATA_HEADER_CONTENT_LANGUAGE
static String
METADATA_HEADER_CONTENT_LENGTH
static String
METADATA_HEADER_CONTENT_MD5
static String
METADATA_HEADER_CONTENT_TYPE
static String
METADATA_HEADER_CREATION_DATE
static String
METADATA_HEADER_DATE
static String
METADATA_HEADER_ETAG
static String
METADATA_HEADER_LAST_MODIFIED_DATE
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAllMetadata(Map<String,Object> metadata)
Adds all the items in the provided map to this object's metadata.void
addMetadata(String name, String value)
Adds a metadata item to the object.void
addMetadata(String name, Date value)
Adds a Date metadata item to the object.void
addMetadata(String name, StorageOwner value)
Adds an owner metadata item to the object.boolean
containsMetadata(String name)
Object
getMetadata(String name)
Map<String,Object>
getMetadataMap()
String
getName()
StorageOwner
getOwner()
void
removeMetadata(String name)
Removes a metadata item from the object.void
replaceAllMetadata(Map<String,Object> metadata)
Removes all the metadata items associated with this object, then adds all the items in the provided map.void
setName(String name)
Set the name of the bucket.void
setOwner(StorageOwner owner)
Set this object's owner object based on information returned from the service.
-
-
-
Field Detail
-
METADATA_HEADER_CREATION_DATE
public static final String METADATA_HEADER_CREATION_DATE
- See Also:
- Constant Field Values
-
METADATA_HEADER_LAST_MODIFIED_DATE
public static final String METADATA_HEADER_LAST_MODIFIED_DATE
- See Also:
- Constant Field Values
-
METADATA_HEADER_DATE
public static final String METADATA_HEADER_DATE
- See Also:
- Constant Field Values
-
METADATA_HEADER_CONTENT_MD5
public static final String METADATA_HEADER_CONTENT_MD5
- See Also:
- Constant Field Values
-
METADATA_HEADER_CONTENT_LENGTH
public static final String METADATA_HEADER_CONTENT_LENGTH
- See Also:
- Constant Field Values
-
METADATA_HEADER_CONTENT_TYPE
public static final String METADATA_HEADER_CONTENT_TYPE
- See Also:
- Constant Field Values
-
METADATA_HEADER_CONTENT_ENCODING
public static final String METADATA_HEADER_CONTENT_ENCODING
- See Also:
- Constant Field Values
-
METADATA_HEADER_CONTENT_DISPOSITION
public static final String METADATA_HEADER_CONTENT_DISPOSITION
- See Also:
- Constant Field Values
-
METADATA_HEADER_CONTENT_LANGUAGE
public static final String METADATA_HEADER_CONTENT_LANGUAGE
- See Also:
- Constant Field Values
-
METADATA_HEADER_ETAG
public static final String METADATA_HEADER_ETAG
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
public String getName()
- Returns:
- the name of the bucket.
-
setName
public void setName(String name)
Set the name of the bucket.- Parameters:
name
- the name for the bucket
-
getMetadataMap
public Map<String,Object> getMetadataMap()
- Returns:
- an immutable map containing all the metadata associated with this object.
-
getMetadata
public Object getMetadata(String name)
- Parameters:
name
- the metadata item name.- Returns:
- the value of the metadata with the given name, or null if no such metadata item exists.
-
containsMetadata
public boolean containsMetadata(String name)
- Parameters:
name
- the metadata item name.- Returns:
- true if this object contains a metadata item with the given name, false otherwise.
-
addMetadata
public void addMetadata(String name, String value)
Adds a metadata item to the object.- Parameters:
name
- the metadata item name.value
- the metadata item value.
-
addMetadata
public void addMetadata(String name, Date value)
Adds a Date metadata item to the object.- Parameters:
name
- the metadata item name.value
- the metadata item's date value.
-
addMetadata
public void addMetadata(String name, StorageOwner value)
Adds an owner metadata item to the object.- Parameters:
name
- the metadata item name.value
- the metadata item's owner value.
-
addAllMetadata
public void addAllMetadata(Map<String,Object> metadata)
Adds all the items in the provided map to this object's metadata.- Parameters:
metadata
- metadata items to add.
-
removeMetadata
public void removeMetadata(String name)
Removes a metadata item from the object.- Parameters:
name
- the name of the metadata item to remove.
-
replaceAllMetadata
public void replaceAllMetadata(Map<String,Object> metadata)
Removes all the metadata items associated with this object, then adds all the items in the provided map. After performing this operation, the metadata list will contain only those items in the provided map.- Parameters:
metadata
- metadata items to add.
-
getOwner
public StorageOwner getOwner()
- Returns:
- this object's owner, or null if the owner is not available.
-
setOwner
public void setOwner(StorageOwner owner)
Set this object's owner object based on information returned from the service. This method should only by used by code that reads service responses.- Parameters:
owner
-
-
-