ch.iterate.openstack.swift

Class Client

java.lang.Object

ch.iterate.openstack.swift.Client

public class Client
extends Object

An OpenStack Swift client interface. Here follows a basic example of logging in, creating a container and an object, retrieving the object, and then deleting both the object and container. For more examples, see the code in com.iterate.openstack.cloudfiles.sample, which contains a series of examples.

  //  Create the openstack object for username "jdoe", password "johnsdogsname".
        FilesClient myClient = FilesClient("jdoe", "johnsdogsname");

  // Log in (login() will return false if the login was unsuccessful.
  assert(myClient.login());

  // Make sure there are no containers in the account
  assert(myClient.listContainers.length() == 0);

  // Create the container
  assert(myClient.createContainer("myContainer"));

  // Now we should have one
  assert(myClient.listContainers.length() == 1);

  // Upload the file "alpaca.jpg"
  assert(myClient.storeObject("myContainer", new File("alapca.jpg"), "image/jpeg"));

  // Download "alpaca.jpg"
  FilesObject obj = myClient.getObject("myContainer", "alpaca.jpg");
  byte data[] = obj.getObject();

  // Clean up after ourselves.
  // Note:  Order here is important, you can't delete non-empty containers.
  assert(myClient.deleteObject("myContainer", "alpaca.jpg"));
  assert(myClient.deleteContainer("myContainer");
 

Author:

lvaughn

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.AuthVersion

Constructor Summary

Constructors

Constructor and Description
Client(org.apache.http.impl.client.CloseableHttpClient client)
Client(int connectionTimeOut)

Method Summary

Modifier and Type	Method and Description
AuthenticationResponse	authenticate(AuthenticationRequest request)
AuthenticationResponse	authenticate(AuthenticationRequest request, org.apache.http.client.ResponseHandler<AuthenticationResponse> handler)
AuthenticationResponse	authenticate(Client.AuthVersion authVersion, URI authenticationURL, String username, String password, String tenantId)
protected void	authorize(org.apache.http.client.methods.HttpRequestBase method)
String	cdnEnableContainer(Region region, String name) Enables access of files in this container via the Content Delivery Network.
String	cdnUpdateContainer(Region region, String name, int ttl, boolean enabled, boolean retainLogs)
boolean	containerExists(Region region, String container) Convenience method to test for the existence of a container in Cloud Files.
String	copyObject(Region region, String sourceContainer, String sourceObjName, String destContainer, String destObjName) This method copies the object found in the source container with the source object name to the destination container with the destination object name.
void	createContainer(Region region, String name) Creates a container
String	createDLOManifestObject(Region region, String container, String contentType, String name, String commonPrefix) Create a Dynamic Large Object manifest on the server, including metadata
String	createDLOManifestObject(Region region, String container, String contentType, String name, String commonPrefix, Map<String,String> metadata) Create a Dynamic Large Object manifest on the server, including metadata
void	createPath(Region region, String container, String path) Creates a path (but not any of the sub portions of the path)
String	createSLOManifestObject(Region region, String container, String contentType, String name, String manifest, Map<String,String> metadata) Create a Static Large Object manifest on the server, including metadata
void	deleteContainer(Region region, String name) Deletes a container
void	deleteObject(Region region, String container, String object) Delete the given object from it's container.
void	deleteObjects(Region region, String container, List<String> objects)
void	disconnect() Release all connections
AccountInfo	getAccountInfo(Region region) Gets information for the given account.
AuthenticationResponse	getAuthentication()
CDNContainer	getCDNContainerInfo(Region region, String container) Gets current CDN sharing status of the container
org.apache.http.impl.client.CloseableHttpClient	getClient()
ContainerInfo	getContainerInfo(Region region, String container) Get basic information on a container (number of items and the total size).
ContainerMetadata	getContainerMetaData(Region region, String container) Get an container's metadata
Response	getObject(Region region, String container, String object) Get's the given object's content as a stream
Response	getObject(Region region, String container, String object, long offset)
Response	getObject(Region region, String container, String object, long offset, long length)
ObjectMetadata	getObjectMetaData(Region region, String container, String object) Get an object's metadata
Set<Region>	getRegions()
boolean	isCDNEnabled(Region region, String container) Gets current CDN sharing status of the container
List<CDNContainer>	listCdnContainerInfo(Region region) Gets list of all of the containers associated with this account.
List<CDNContainer>	listCdnContainerInfo(Region region, int limit) Gets list of all of the containers associated with this account.
List<CDNContainer>	listCdnContainerInfo(Region region, int limit, String marker) Gets list of all of the containers associated with this account.
List<Container>	listContainers(Region region) List the containers available in an account.
List<Container>	listContainers(Region region, int limit) List the containers available in an account.
List<Container>	listContainers(Region region, int limit, String marker) List the containers available in an account.
List<ContainerInfo>	listContainersInfo(Region region) List all of the containers available in an account, ordered by container name.
List<ContainerInfo>	listContainersInfo(Region region, int limit) List the containers available in an account, ordered by container name.
List<ContainerInfo>	listContainersInfo(Region region, int limit, String marker) List the containers available in an account, ordered by container name.
List<StorageObject>	listObjects(Region region, String container) List the objects in a container in lexicographic order.
List<StorageObject>	listObjects(Region region, String container, Character delimiter) List the objects in a container in lexicographic order.
List<StorageObject>	listObjects(Region region, String container, int limit) List the objects in a container in lexicographic order.
List<StorageObject>	listObjects(Region region, String container, int limit, String marker) List the objects in a container in lexicographic order.
List<StorageObject>	listObjects(Region region, String container, String path) List the objects in a container in lexicographic order.
List<StorageObject>	listObjects(Region region, String container, String path, Character delimiter) List the objects in a container in lexicographic order.
List<StorageObject>	listObjects(Region region, String container, String path, int limit) List the objects in a container in lexicographic order.
List<StorageObject>	listObjects(Region region, String container, String path, int limit, String marker) List the objects in a container in lexicographic order.
Map<String,List<StorageObject>>	listObjectSegments(Region region, String container, String name) Lists the segments associated with an existing object.
List<StorageObject>	listObjectsStartingWith(Region region, String container, String startsWith, String path, int limit, String marker) List all of the objects in a container with the given starting string.
List<StorageObject>	listObjectsStartingWith(Region region, String container, String startsWith, String path, int limit, String marker, Character delimiter) List all of the objects in a container with the given starting string.
void	purgeCDNContainer(Region region, String container, String emailAddresses) Purges all items from a given container from the CDN
void	purgeCDNObject(Region region, String container, String object, String emailAddresses) Purges all items from a given container from the CDN
String	storeObject(Region region, String container, InputStream data, String contentType, String name, Map<String,String> metadata) Store a file on the server, including metadata, with the contents coming from an input stream.
String	storeObject(Region region, String container, String name, org.apache.http.HttpEntity entity, Map<String,String> metadata, String md5sum)
String	storeObject(Region region, String container, String name, org.apache.http.HttpEntity entity, Map<String,String> metadata, String md5sum, Long objectSize)
String	storeObject(Region region, String container, String name, org.apache.http.HttpEntity entity, Map<String,String> metadata, String md5sum, Long objectSize, Long segmentSize, Boolean dynamicLargeObject, String segmentContainer, String segmentFolder, Boolean leaveSegments)
void	updateAccountMetadata(Region region, Map<String,String> metadata)
void	updateContainerMetadata(Region region, String container, Map<String,String> metadata)
void	updateObjectManifest(Region region, String container, String object, String manifest)
void	updateObjectMetadata(Region region, String container, String object, Map<String,String> metadata)
void	updateObjectMetadataAndManifest(Region region, String container, String object, Map<String,String> metadata, String manifest)

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(int connectionTimeOut)

Parameters:

connectionTimeOut - The connection timeout, in ms.

Client

public Client(org.apache.http.impl.client.CloseableHttpClient client)

Parameters:

client - The HttpClient to talk to Swift

Method Detail

getClient

public org.apache.http.impl.client.CloseableHttpClient getClient()

disconnect

public void disconnect()
                throws IOException

Release all connections

Throws:

IOException

authenticate

public AuthenticationResponse authenticate(Client.AuthVersion authVersion,
                                           URI authenticationURL,
                                           String username,
                                           String password,
                                           String tenantId)
                                    throws IOException

Parameters:

authVersion - Version

authenticationURL - Authentication endpoint of identity service

username - User or access key

password - Password or secret key

tenantId - Tenant or null

Returns:

Authentication response with supported regions and authentication token for subsequent requests

Throws:

IOException

authenticate

public AuthenticationResponse authenticate(AuthenticationRequest request)
                                    throws IOException

Throws:

IOException

authenticate

public AuthenticationResponse authenticate(AuthenticationRequest request,
                                           org.apache.http.client.ResponseHandler<AuthenticationResponse> handler)
                                    throws IOException

Throws:

IOException

getAuthentication

public AuthenticationResponse getAuthentication()

getRegions

public Set<Region> getRegions()

listContainersInfo

public List<ContainerInfo> listContainersInfo(Region region)
                                       throws IOException

List all of the containers available in an account, ordered by container name.

Returns:

null if the user is not logged in or the Account is not found. A List of FSContainers with all of the containers in the account. if there are no containers in the account, the list will be zero length.

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

listContainersInfo

public List<ContainerInfo> listContainersInfo(Region region,
                                              int limit)
                                       throws IOException

List the containers available in an account, ordered by container name.

Parameters:

limit - The maximum number of containers to return. -1 returns an unlimited number.

Returns:

null if the user is not logged in or the Account is not found. A List of FSContainers with all of the containers in the account. if there are no containers in the account, the list will be zero length.

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

listContainersInfo

public List<ContainerInfo> listContainersInfo(Region region,
                                              int limit,
                                              String marker)
                                       throws IOException

List the containers available in an account, ordered by container name.

Parameters:

limit - The maximum number of containers to return. -1 returns an unlimited number.

marker - Return containers that occur after this lexicographically.

Returns:

null if the user is not logged in or the Account is not found. A List of FSContainers with all of the containers in the account. if there are no containers in the account, the list will be zero length.

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

listContainers

public List<Container> listContainers(Region region)
                               throws IOException

List the containers available in an account.

Returns:

null if the user is not logged in or the Account is not found. A List of FilesContainer with all of the containers in the account. if there are no containers in the account, the list will be zero length.

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

listContainers

public List<Container> listContainers(Region region,
                                      int limit)
                               throws IOException

List the containers available in an account.

Parameters:

limit - The maximum number of containers to return. -1 denotes no limit.

Returns:

null if the user is not logged in or the Account is not found. A List of FilesContainer with all of the containers in the account. if there are no containers in the account, the list will be zero length.

Throws:

IOException - There was an IO error doing network communication

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

listContainers

public List<Container> listContainers(Region region,
                                      int limit,
                                      String marker)
                               throws IOException

List the containers available in an account.

Parameters:

limit - The maximum number of containers to return. -1 denotes no limit.

marker - Only return containers after this container. Null denotes starting at the beginning (lexicographically).

Returns:

A List of FilesContainer with all of the containers in the account. if there are no containers in the account, the list will be zero length.

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

authorize

protected void authorize(org.apache.http.client.methods.HttpRequestBase method)

listObjectsStartingWith

public List<StorageObject> listObjectsStartingWith(Region region,
                                                   String container,
                                                   String startsWith,
                                                   String path,
                                                   int limit,
                                                   String marker)
                                            throws IOException

List all of the objects in a container with the given starting string.

Parameters:

container - The container name

startsWith - The string to start with

path - Only look for objects in this path

limit - Return at most limit objects

marker - Returns objects lexicographically greater than marker. Used in conjunction with limit to paginate the list.

Returns:

A list of FilesObjects starting with the given string

Throws:

IOException - There was an IO error doing network communication

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

listObjectsStartingWith

public List<StorageObject> listObjectsStartingWith(Region region,
                                                   String container,
                                                   String startsWith,
                                                   String path,
                                                   int limit,
                                                   String marker,
                                                   Character delimiter)
                                            throws IOException

List all of the objects in a container with the given starting string.

Parameters:

container - The container name

startsWith - The string to start with

path - Only look for objects in this path

limit - Return at most limit objects

marker - Returns objects lexicographically greater than marker. Used in conjunction with limit to paginate the list.

delimiter - Use this argument as the delimiter that separates "directories"

Returns:

A list of FilesObjects starting with the given string

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

listObjects

public List<StorageObject> listObjects(Region region,
                                       String container)
                                throws IOException

List the objects in a container in lexicographic order.

Parameters:

container - The container name

Returns:

A list of FilesObjects starting with the given string

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

listObjects

public List<StorageObject> listObjects(Region region,
                                       String container,
                                       Character delimiter)
                                throws IOException

List the objects in a container in lexicographic order.

Parameters:

container - The container name

delimiter - Use this argument as the delimiter that separates "directories"

Returns:

A list of FilesObjects starting with the given string

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

listObjects

public List<StorageObject> listObjects(Region region,
                                       String container,
                                       int limit)
                                throws IOException

List the objects in a container in lexicographic order.

Parameters:

container - The container name

limit - Return at most limit objects

Returns:

A list of FilesObjects starting with the given string

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

listObjects

public List<StorageObject> listObjects(Region region,
                                       String container,
                                       String path)
                                throws IOException

List the objects in a container in lexicographic order.

Parameters:

container - The container name

path - Only look for objects in this path

Returns:

A list of FilesObjects starting with the given string

Throws:

GenericException - Unexpected response

AuthorizationException

IOException

listObjects

public List<StorageObject> listObjects(Region region,
                                       String container,
                                       String path,
                                       Character delimiter)
                                throws IOException

List the objects in a container in lexicographic order.

Parameters:

container - The container name

path - Only look for objects in this path

delimiter - Use this argument as the delimiter that separates "directories"

Returns:

A list of FilesObjects starting with the given string

Throws:

IOException - There was an IO error doing network communication

GenericException - Unexpected response

AuthorizationException

listObjects

public List<StorageObject> listObjects(Region region,
                                       String container,
                                       String path,
                                       int limit)
                                throws IOException

List the objects in a container in lexicographic order.

Parameters:

container - The container name

path - Only look for objects in this path

limit - Return at most limit objects

Returns:

A list of FilesObjects starting with the given string

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

listObjects

public List<StorageObject> listObjects(Region region,
                                       String container,
                                       String path,
                                       int limit,
                                       String marker)
                                throws IOException

List the objects in a container in lexicographic order.

Parameters:

container - The container name

path - Only look for objects in this path

limit - Return at most limit objects

marker - Returns objects lexicographically greater than marker. Used in conjunction with limit to paginate the list.

Returns:

A list of FilesObjects starting with the given string

Throws:

GenericException - Unexpected response

AuthorizationException

IOException

listObjects

public List<StorageObject> listObjects(Region region,
                                       String container,
                                       int limit,
                                       String marker)
                                throws IOException

List the objects in a container in lexicographic order.

Parameters:

container - The container name

limit - Return at most limit objects

marker - Returns objects lexicographically greater than marker. Used in conjunction with limit to paginate the list.

Returns:

A list of FilesObjects starting with the given string

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

containerExists

public boolean containerExists(Region region,
                               String container)
                        throws IOException

Convenience method to test for the existence of a container in Cloud Files.

Parameters:

container - Container name

Returns:

true if the container exists. false otherwise.

Throws:

GenericException - Unexpected response

IOException

getAccountInfo

public AccountInfo getAccountInfo(Region region)
                           throws IOException

Gets information for the given account.

Returns:

The FilesAccountInfo with information about the number of containers and number of bytes used by the given account.

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack's login was invalid.

IOException

getContainerInfo

public ContainerInfo getContainerInfo(Region region,
                                      String container)
                               throws IOException

Get basic information on a container (number of items and the total size).

Parameters:

container - The container to get information for

Returns:

ContainerInfo object of the container is present or null if its not present

Throws:

GenericException - There was an protocol level exception while talking to Cloudfiles

NotFoundException - The container was not found

AuthorizationException - The openstack was not logged in or the log in expired.

IOException

createContainer

public void createContainer(Region region,
                            String name)
                     throws IOException

Creates a container

Parameters:

name - The name of the container to be created

Throws:

GenericException - Unexpected response

AuthorizationException - The openstack was not property logged in

IOException

deleteContainer

public void deleteContainer(Region region,
                            String name)
                     throws IOException

Deletes a container

Parameters:

name - The name of the container

Throws:

GenericException - Unexpected response

AuthorizationException - The user is not Logged in

NotFoundException - The container doesn't exist

ContainerNotEmptyException - The container was not empty

IOException

cdnEnableContainer

public String cdnEnableContainer(Region region,
                                 String name)
                          throws IOException

Enables access of files in this container via the Content Delivery Network.

Parameters:

name - The name of the container to enable

Returns:

The CDN Url of the container

Throws:

IOException - There was an IO error doing network communication

GenericException - Unexpected response

cdnUpdateContainer

public String cdnUpdateContainer(Region region,
                                 String name,
                                 int ttl,
                                 boolean enabled,
                                 boolean retainLogs)
                          throws IOException

Throws:

IOException

getCDNContainerInfo

public CDNContainer getCDNContainerInfo(Region region,
                                        String container)
                                 throws IOException

Gets current CDN sharing status of the container

Parameters:

container - Container

Returns:

Information on the container

Throws:

GenericException - Unexpected response

NotFoundException - The Container has never been CDN enabled

IOException

isCDNEnabled

public boolean isCDNEnabled(Region region,
                            String container)
                     throws IOException

Gets current CDN sharing status of the container

Parameters:

container - Container name

Returns:

Information on the container

Throws:

GenericException - Unexpected response

NotFoundException - The Container has never been CDN enabled

IOException

createPath

public void createPath(Region region,
                       String container,
                       String path)
                throws IOException

Creates a path (but not any of the sub portions of the path)

Parameters:

container - The name of the container.

path - The name of the Path

Throws:

GenericException - Unexpected response

IOException

purgeCDNContainer

public void purgeCDNContainer(Region region,
                              String container,
                              String emailAddresses)
                       throws IOException

Purges all items from a given container from the CDN

Parameters:

container - The name of the container

emailAddresses - An optional comma separated list of email addresses to be notified when the purge is complete. null if desired.

Throws:

AuthorizationException - Log in was not successful, or account is suspended

GenericException - Unexpected response

IOException

purgeCDNObject

public void purgeCDNObject(Region region,
                           String container,
                           String object,
                           String emailAddresses)
                    throws IOException

Purges all items from a given container from the CDN

Parameters:

container - The name of the container

object - The name of the object

emailAddresses - An optional comma separated list of email addresses to be notified when the purge is complete. null if desired.

Throws:

GenericException - Unexpected response

AuthorizationException - Log in was not successful, or account is suspended

IOException

listCdnContainerInfo

public List<CDNContainer> listCdnContainerInfo(Region region)
                                        throws IOException

Gets list of all of the containers associated with this account.

Parameters:

region - The name of the storage region

Returns:

A list of containers

Throws:

GenericException - Unexpected response

IOException

listCdnContainerInfo

public List<CDNContainer> listCdnContainerInfo(Region region,
                                               int limit)
                                        throws IOException

Gets list of all of the containers associated with this account.

Parameters:

region - The name of the storage region

limit - The maximum number of container names to return

Returns:

A list of containers

Throws:

GenericException - Unexpected response

IOException

listCdnContainerInfo

public List<CDNContainer> listCdnContainerInfo(Region region,
                                               int limit,
                                               String marker)
                                        throws IOException

Gets list of all of the containers associated with this account.

Parameters:

region - The name of the storage region

limit - The maximum number of container names to return

marker - All of the names will come after marker lexicographically.

Returns:

A list of containers

Throws:

GenericException - Unexpected response

IOException

createDLOManifestObject

public String createDLOManifestObject(Region region,
                                      String container,
                                      String contentType,
                                      String name,
                                      String commonPrefix)
                               throws IOException

Create a Dynamic Large Object manifest on the server, including metadata

Parameters:

region - The name of the storage region

container - The name of the container

contentType - The MIME type of the file

name - The name of the file on the server

commonPrefix - Set manifest header content here (the shared prefix of objects that make up the dynamic large object)

Returns:

the ETAG of the large object if response code is 201

Throws:

GenericException - Unexpected response

IOException

createDLOManifestObject

public String createDLOManifestObject(Region region,
                                      String container,
                                      String contentType,
                                      String name,
                                      String commonPrefix,
                                      Map<String,String> metadata)
                               throws IOException

Create a Dynamic Large Object manifest on the server, including metadata

Parameters:

region - The name of the storage region

container - The name of the container

contentType - The MIME type of the file

name - The name of the file on the server

commonPrefix - Set manifest header content here (the shared prefix of objects that make up the dynamic large object)

metadata - A map with the metadata as key names and values as the metadata values

Returns:

the ETAG of the large object if response code is 201

Throws:

GenericException - Unexpected response

IOException

createSLOManifestObject

public String createSLOManifestObject(Region region,
                                      String container,
                                      String contentType,
                                      String name,
                                      String manifest,
                                      Map<String,String> metadata)
                               throws IOException

Create a Static Large Object manifest on the server, including metadata

Parameters:

region - The name of the storage region

container - The name of the container

contentType - The MIME type of the file

name - The name of the file on the server

manifest - Set manifest content here (A JSON string describing the large object contents) Should be an ordered list of maps with the following keys for each object segment: - "path" the path (including container) to the object segment - "size_bytes" the size in byes of the segment - "etag" the etag of the segment

metadata - A map with the metadata as key names and values as the metadata values

Returns:

True if response code is 201

Throws:

GenericException - Unexpected response

IOException

listObjectSegments

public Map<String,List<StorageObject>> listObjectSegments(Region region,
                                                          String container,
                                                          String name)
                                                   throws IOException

Lists the segments associated with an existing object.

Parameters:

region - The name of the storage region

container - The name of the container

name - The name of the object

Returns:

a Map from container to lists of storage objects if a large object is present, otherwise null

Throws:

IOException

storeObject

public String storeObject(Region region,
                          String container,
                          InputStream data,
                          String contentType,
                          String name,
                          Map<String,String> metadata)
                   throws IOException

Store a file on the server, including metadata, with the contents coming from an input stream. This allows you to not know the entire length of your content when you start to write it. Nor do you have to hold it entirely in memory at the same time.

Parameters:

region - The name of the storage region

container - The name of the container

data - Any object that implements InputStream

contentType - The MIME type of the file

name - The name of the file on the server

metadata - A map with the metadata as key names and values as the metadata values

Returns:

the file ETAG if response code is 201

Throws:

GenericException - Unexpected response

IOException

storeObject

public String storeObject(Region region,
                          String container,
                          String name,
                          org.apache.http.HttpEntity entity,
                          Map<String,String> metadata,
                          String md5sum)
                   throws IOException

Parameters:

region - The name of the storage region

container - The name of the container

name - The name of the object

entity - The name of the request entity (make sure to set the Content-Type

metadata - The metadata for the object

md5sum - The 32 character hex encoded MD5 sum of the data

Returns:

The ETAG if the save was successful, null otherwise

Throws:

GenericException - There was a protocol level error talking to CloudFiles

IOException

storeObject

public String storeObject(Region region,
                          String container,
                          String name,
                          org.apache.http.HttpEntity entity,
                          Map<String,String> metadata,
                          String md5sum,
                          Long objectSize,
                          Long segmentSize,
                          Boolean dynamicLargeObject,
                          String segmentContainer,
                          String segmentFolder,
                          Boolean leaveSegments)
                   throws IOException,
                          InterruptedException

Parameters:

container - The name of the container

name - The name of the object

entity - The name of the request entity (make sure to set the Content-Type

metadata - The metadata for the object

md5sum - The 32 character hex encoded MD5 sum of the data

objectSize - The total size in bytes of the object to be stored

segmentSize - Optional size in bytes of the object segments to be stored (forces large object support) default 4G

dynamicLargeObject - Optional setting to use dynamic large objects, False/null will use static large objects if required

segmentContainer - Optional name of container to store file segments, defaults to storing chunks in the same container as the file sill appear

segmentFolder - Optional name of folder for storing file segments, defaults to ".chunks/"

leaveSegments - Optional setting to leave segments of large objects in place when the manifest is overwrtten/changed

Returns:

The ETAG if the save was successful, null otherwise

Throws:

GenericException - There was a protocol level error talking to CloudFiles

IOException

InterruptedException

storeObject

public String storeObject(Region region,
                          String container,
                          String name,
                          org.apache.http.HttpEntity entity,
                          Map<String,String> metadata,
                          String md5sum,
                          Long objectSize)
                   throws IOException,
                          InterruptedException

Parameters:

container - The name of the container

name - The name of the object

entity - The name of the request entity (make sure to set the Content-Type

metadata - The metadata for the object

md5sum - The 32 character hex encoded MD5 sum of the data

objectSize - The total size in bytes of the object to be stored

Returns:

The ETAG if the save was successful, null otherwise

Throws:

GenericException - There was a protocol level error talking to CloudFiles

IOException

InterruptedException

copyObject

public String copyObject(Region region,
                         String sourceContainer,
                         String sourceObjName,
                         String destContainer,
                         String destObjName)
                  throws IOException

This method copies the object found in the source container with the source object name to the destination container with the destination object name.

Parameters:

sourceContainer - of object to copy

sourceObjName - of object to copy

destContainer - where object copy will be copied

destObjName - of object copy

Returns:

ETag if successful, else null

Throws:

GenericException - Unexpected response

IOException

deleteObject

public void deleteObject(Region region,
                         String container,
                         String object)
                  throws IOException

Delete the given object from it's container.

Parameters:

container - The container name

object - The object name

Throws:

IOException - There was an IO error doing network communication

GenericException - Unexpected response

NotFoundException - The file was not found

deleteObjects

public void deleteObjects(Region region,
                          String container,
                          List<String> objects)
                   throws IOException

Throws:

IOException

getObjectMetaData

public ObjectMetadata getObjectMetaData(Region region,
                                        String container,
                                        String object)
                                 throws IOException

Get an object's metadata

Parameters:

container - The name of the container

object - The name of the object

Returns:

The object's metadata

Throws:

GenericException - Unexpected response

AuthorizationException - The Client's Login was invalid.

NotFoundException - The file was not found

IOException

getContainerMetaData

public ContainerMetadata getContainerMetaData(Region region,
                                              String container)
                                       throws IOException

Get an container's metadata

Parameters:

container - The name of the container

Returns:

The container's metadata

Throws:

GenericException - Unexpected response

AuthorizationException - The Client's Login was invalid.

IOException

getObject

public Response getObject(Region region,
                          String container,
                          String object)
                   throws IOException

Get's the given object's content as a stream

Parameters:

container - The name of the container

object - The name of the object

Returns:

An input stream that will give the objects content when read from.

Throws:

GenericException - Unexpected response

IOException

getObject

public Response getObject(Region region,
                          String container,
                          String object,
                          long offset)
                   throws IOException

Throws:

IOException

getObject

public Response getObject(Region region,
                          String container,
                          String object,
                          long offset,
                          long length)
                   throws IOException

Throws:

IOException

updateObjectManifest

public void updateObjectManifest(Region region,
                                 String container,
                                 String object,
                                 String manifest)
                          throws IOException

Throws:

IOException

updateObjectMetadata

public void updateObjectMetadata(Region region,
                                 String container,
                                 String object,
                                 Map<String,String> metadata)
                          throws IOException

Throws:

IOException

updateObjectMetadataAndManifest

public void updateObjectMetadataAndManifest(Region region,
                                            String container,
                                            String object,
                                            Map<String,String> metadata,
                                            String manifest)
                                     throws IOException

Throws:

IOException

updateContainerMetadata

public void updateContainerMetadata(Region region,
                                    String container,
                                    Map<String,String> metadata)
                             throws IOException

Throws:

IOException

updateAccountMetadata

public void updateAccountMetadata(Region region,
                                  Map<String,String> metadata)
                           throws IOException

Throws:

IOException