org.openstack4j.openstack.storage.object.internal

Class ObjectStorageContainerServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

org.openstack4j.openstack.storage.object.internal.BaseObjectStorageService

org.openstack4j.openstack.storage.object.internal.ObjectStorageContainerServiceImpl

All Implemented Interfaces:

ObjectStorageContainerService, RestService

public class ObjectStorageContainerServiceImpl
extends BaseObjectStorageService
implements ObjectStorageContainerService

Provides access to the OpenStack Object Storage (Swift) Container API features.

Author:

Jeremy Unruh

Nested Class Summary

Nested classes/interfaces inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor and Description
ObjectStorageContainerServiceImpl()

Method Summary

Modifier and Type	Method and Description
ActionResponse	create(String name) Creates a new container with the specified name
ActionResponse	create(String name, CreateUpdateContainerOptions options) Creates a new container with the specified name with options
String	createPath(String containerName, String path) Creates a pseudo path aka directory for the specified containerName
ActionResponse	delete(String name) Deletes an empty container with the specified name
boolean	deleteMetadata(String name, Map<String,String> metadata) Deletes metadata items from the specified container name
Map<String,String>	getMetadata(String name) Gets the Metadata for a given container
List<? extends SwiftContainer>	list() Listing of all containers associated with the Account (max result size is 10,000);
List<? extends SwiftContainer>	list(ContainerListOptions options) Listing of all containers with the associated options used in the query
ActionResponse	update(String name, CreateUpdateContainerOptions options) Updates a container with the specified name with options
boolean	updateMetadata(String name, Map<String,String> metadata) Creates or Updates metadata items for the specified container name

Methods inherited from class org.openstack4j.openstack.storage.object.internal.BaseObjectStorageService

isResponseSuccess, isResponseSuccess

Methods inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

delete, deleteWithResponse, get, getProvider, getServiceVersion, getXOpenstackRequestId, head, patch, patchWithResponse, post, postWithResponse, put, request, toList, uri

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectStorageContainerServiceImpl

public ObjectStorageContainerServiceImpl()

Method Detail

list

public List<? extends SwiftContainer> list()

Listing of all containers associated with the Account (max result size is 10,000);

Specified by:

list in interface ObjectStorageContainerService

Returns:

List of containers ordered by name

list

public List<? extends SwiftContainer> list(ContainerListOptions options)

Listing of all containers with the associated options used in the query

Specified by:

list in interface ObjectStorageContainerService

Parameters:

options - the query based options

Returns:

List of containers ordered by name

create

public ActionResponse create(String name)

Creates a new container with the specified name

Specified by:

create in interface ObjectStorageContainerService

Parameters:

name - the name of the new container

Returns:

the action response

create

public ActionResponse create(String name,
                             CreateUpdateContainerOptions options)

Creates a new container with the specified name with options

Specified by:

create in interface ObjectStorageContainerService

Parameters:

name - the name of the new container

options - the options to use when creating a container

Returns:

the action response

createPath

public String createPath(String containerName,
                         String path)

Creates a pseudo path aka directory for the specified containerName

Specified by:

createPath in interface ObjectStorageContainerService

Parameters:

containerName - the name of the container

path - the path to create

Returns:

the ETAG checksum of the new path

update

public ActionResponse update(String name,
                             CreateUpdateContainerOptions options)

Updates a container with the specified name with options

Specified by:

update in interface ObjectStorageContainerService

Parameters:

name - the name of the container to update

options - the options to use when updating a container

delete

public ActionResponse delete(String name)

Deletes an empty container with the specified name

Specified by:

delete in interface ObjectStorageContainerService

Parameters:

name - the name of the container to delete

Returns:

the action response (true if successfully deleted)

getMetadata

public Map<String,String> getMetadata(String name)

Gets the Metadata for a given container

Specified by:

getMetadata in interface ObjectStorageContainerService

Parameters:

name - the container name

Returns:

Map of key to value metadata

updateMetadata

public boolean updateMetadata(String name,
                              Map<String,String> metadata)

Creates or Updates metadata items for the specified container name

Specified by:

updateMetadata in interface ObjectStorageContainerService

Parameters:

name - the name of the container

metadata - the metadata to create/update for this container

Returns:

true if the create/update was successful, false if not

deleteMetadata

public boolean deleteMetadata(String name,
                              Map<String,String> metadata)

Deletes metadata items from the specified container name

Specified by:

deleteMetadata in interface ObjectStorageContainerService

Parameters:

name - the name of the container

metadata - the metadata items to remove from the container's metadata

Returns:

true if the removal of items was successful, false if not