org.jclouds.openstack.swift
Interface CommonSwiftClient

All Superinterfaces:

Closeable

All Known Subinterfaces:

SwiftClient, SwiftKeystoneClient

Deprecated. Please use com.jclouds.openstack.swift.v1.SwiftApi and related feature APIs in com.jclouds.openstack.swift.v1.features.* as noted in each method. This interface will be removed in jclouds 2.0.

@Deprecated
public interface CommonSwiftClient
extends Closeable

Common features in OpenStack Swift.

Method Summary

boolean	containerExists(String container) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#head()
boolean	copyObject(String sourceContainer, String sourceObject, String destinationContainer, String destinationObject) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#copy()
boolean	createContainer(String container) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#createIfAbsent()
boolean	createContainer(String container, CreateContainerOptions... options) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#createIfAbsent()
boolean	deleteContainerIfEmpty(String container) Deprecated. This method will be replaced by (@link com.jclouds.openstack.swift.v1.features.ContainerApi#deleteIfEmpty()}
boolean	deleteContainerMetadata(String container, Iterable<String> metadataKeys) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#deleteMetadata()
AccountMetadata	getAccountStatistics() Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.AccountApi#get()
ContainerMetadata	getContainerMetadata(String container) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#get()
SwiftObject	getObject(String container, String name, org.jclouds.http.options.GetOptions... options) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#get()
MutableObjectInfoWithMetadata	getObjectInfo(String container, String name) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#head()
Set<ContainerMetadata>	listContainers(ListContainerOptions... options) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#list() and com.jclouds.openstack.swift.v1.features.ContainerApi#list(ListContainerOptions)
org.jclouds.blobstore.domain.PageSet<ObjectInfo>	listObjects(String container, ListContainerOptions... options) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#list() and com.jclouds.openstack.swift.v1.features.ObjectApi#list(ListContainerOptions)
SwiftObject	newSwiftObject() Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.domain.SwiftObject#builder()
boolean	objectExists(String container, String name) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#head()
String	putObject(String container, SwiftObject object) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#replace()
String	putObjectManifest(String container, String name) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#replaceManifest()
void	removeObject(String container, String name) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#delete()
boolean	setContainerMetadata(String container, Map<String,String> containerMetadata) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#updateMetadata()
boolean	setObjectInfo(String container, String name, Map<String,String> userMetadata) Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi@updateMetadata()

Methods inherited from interface java.io.Closeable

close

Method Detail

newSwiftObject

@Provides
SwiftObject newSwiftObject()

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.domain.SwiftObject#builder()

getAccountStatistics

AccountMetadata getAccountStatistics()

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.AccountApi#get()

HEAD operations against an identity are performed to retrieve the number of Containers and the total bytes stored in Cloud Files for the identity.

Determine the number of Containers within the identity and the total bytes stored. Since the storage system is designed to store large amounts of data, care should be taken when representing the total bytes response as an integer; when possible, convert it to a 64-bit unsigned integer if your platform supports that primitive flavor.

Returns:

the AccountMetadata

listContainers

Set<ContainerMetadata> listContainers(ListContainerOptions... options)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#list() and com.jclouds.openstack.swift.v1.features.ContainerApi#list(ListContainerOptions)

GET operations against the X-Storage-Url for an identity are performed to retrieve a list of existing storage

Containers ordered by name. The following list describes the optional query parameters that are supported with this request.

• limit - For an integer value N, limits the number of results to at most N values.
• marker - Given a string value X, return Object names greater in value than the specified marker.
• format - Specify either json or xml to return the respective serialized response.

At this time, a prex query parameter is not supported at the Account level.

Large Container Lists

The system will return a maximum of 10,000 Container names per request. To retrieve subsequent container names, another request must be made with a marker parameter. The marker indicates where the last list left off and the system will return container names greater than this marker, up to 10,000 again. Note that the marker value should be URL encoded prior to sending the HTTP request.

If 10,000 is larger than desired, a limit parameter may be given.

If the number of container names returned equals the limit given (or 10,000 if no limit is given), it can be assumed there are more container names to be listed. If the container name list is exactly divisible by the limit, the last request will simply have no content.

getContainerMetadata

ContainerMetadata getContainerMetadata(String container)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#get()

Get the ContainerMetadata for the specified container.

Parameters:

container - the container to get the metadata from

Returns:

the ContainerMetadata

setContainerMetadata

boolean setContainerMetadata(String container,
                             Map<String,String> containerMetadata)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#updateMetadata()

Set the ContainerMetadata on the given container.

Parameters:

container - the container to set the metadata on

containerMetadata - a Map<String, String> containing the metadata

Returns:

true if the Container Metadata was successfully created or updated, false if not.

deleteContainerMetadata

boolean deleteContainerMetadata(String container,
                                Iterable<String> metadataKeys)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#deleteMetadata()

Delete the metadata on the given container.

Parameters:

container - the container to delete the metadata from

metadataKeys - the metadata keys

Returns:

true if the Container was successfully deleted, false if not.

createContainer

boolean createContainer(String container)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#createIfAbsent()

Create a container.

Parameters:

container - the name of the container

Returns:

true if the Container was successfully created, false if not.

createContainer

boolean createContainer(String container,
                        CreateContainerOptions... options)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#createIfAbsent()

deleteContainerIfEmpty

boolean deleteContainerIfEmpty(String container)

Deprecated. This method will be replaced by (@link com.jclouds.openstack.swift.v1.features.ContainerApi#deleteIfEmpty()}

containerExists

boolean containerExists(String container)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ContainerApi#head()

listObjects

org.jclouds.blobstore.domain.PageSet<ObjectInfo> listObjects(String container,
                                                             ListContainerOptions... options)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#list() and com.jclouds.openstack.swift.v1.features.ObjectApi#list(ListContainerOptions)

getObject

SwiftObject getObject(String container,
                      String name,
                      org.jclouds.http.options.GetOptions... options)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#get()

setObjectInfo

boolean setObjectInfo(String container,
                      String name,
                      Map<String,String> userMetadata)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi@updateMetadata()

getObjectInfo

MutableObjectInfoWithMetadata getObjectInfo(String container,
                                            String name)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#head()

putObject

String putObject(String container,
                 SwiftObject object)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#replace()

copyObject

boolean copyObject(String sourceContainer,
                   String sourceObject,
                   String destinationContainer,
                   String destinationObject)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#copy()

Returns:

True If the object was copied

Throws:

CopyObjectException - If the object was not copied

removeObject

void removeObject(String container,
                  String name)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#delete()

objectExists

boolean objectExists(String container,
                     String name)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#head()

Throws:

org.jclouds.blobstore.ContainerNotFoundException - if the container is not present

putObjectManifest

String putObjectManifest(String container,
                         String name)

Deprecated. This method will be replaced by com.jclouds.openstack.swift.v1.features.ObjectApi#replaceManifest()