Package org.openstack4j.openstack.storage.object.internal

Class ObjectStorageObjectServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

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

org.openstack4j.openstack.storage.object.internal.ObjectStorageObjectServiceImpl

All Implemented Interfaces:

ObjectStorageObjectService, RestService

public class ObjectStorageObjectServiceImpl
extends BaseObjectStorageService
implements ObjectStorageObjectService

A service responsible for maintaining directory and file objects within containers for an Object Service within OpenStack

Author:

Jeremy Unruh

Nested Class Summary

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

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor	Description
ObjectStorageObjectServiceImpl()

Method Summary

Modifier and Type	Method	Description
String	copy(ObjectLocation source, ObjectLocation dest)	Copies an object to another object in the object store
ActionResponse	delete(String containerName, String name)	Deletes an Object from the specified container
ActionResponse	delete(ObjectLocation location)	Deletes an Object from the specified container
ActionResponse	delete(ObjectLocation location, ObjectDeleteOptions options)	Deletes an Object from the specified container
DLPayload	download(String containerName, String name)	Retrieves the Payload for the data backing the given containerName and name
DLPayload	download(String containerName, String name, DownloadOptions options)	Retrieves the Payload for the data backing the given containerName and name
DLPayload	download(ObjectLocation location, DownloadOptions options)	Retrieves the Payload for the data backing the given location
SwiftObject	get(String containerName, String name)	Gets the specified object based on the containerName and name of the object
SwiftObject	get(ObjectLocation location)	Gets the specified object based on the ObjectLocation location
Map<String,String>	getMetadata(String containerName, String name)	See ObjectStorageObjectService.getMetadata(ObjectLocation)
Map<String,String>	getMetadata(ObjectLocation location)	Gets the metadata for the specified object location
List<? extends SwiftObject>	list(String containerName)	Lists all objects for the given container name
List<? extends SwiftObject>	list(String containerName, ObjectListOptions options)	Lists all objects for the given container name and list options
String	put(String containerName, String name, Payload<?> payload)	Adds/Updates a file to the specified container
String	put(String containerName, String name, Payload<?> payload, ObjectPutOptions options)	Adds/Updates a file to the specified container
boolean	updateMetadata(ObjectLocation location, Map<String,String> metadata)	Creates or Updates the given metadata for the specified object location

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, getWithResponse, getXOpenstackRequestId, head, patch, patchWithResponse, post, postWithResponse, put, putWithResponse, request, toList, uri

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectStorageObjectServiceImpl

public ObjectStorageObjectServiceImpl()

Method Detail

list

public List<? extends SwiftObject> list(String containerName)

Description copied from interface: ObjectStorageObjectService

Lists all objects for the given container name

Specified by:

list in interface ObjectStorageObjectService

Parameters:

containerName - the container name

Returns:

List of File objects including Directories

list

public List<? extends SwiftObject> list(String containerName,
                                        ObjectListOptions options)

Description copied from interface: ObjectStorageObjectService

Lists all objects for the given container name and list options

Specified by:

list in interface ObjectStorageObjectService

Parameters:

containerName - the container name

options - additional filter based options

Returns:

List of File objects including Directories

get

public SwiftObject get(ObjectLocation location)

Gets the specified object based on the ObjectLocation location

Specified by:

get in interface ObjectStorageObjectService

Parameters:

location - the object location

Returns:

SwiftObject or null if not found

get

public SwiftObject get(String containerName,
                       String name)

Gets the specified object based on the containerName and name of the object

Specified by:

get in interface ObjectStorageObjectService

Parameters:

containerName - the objects container name

name - the name of the object

Returns:

SwiftObject or null if not found

put

public String put(String containerName,
                  String name,
                  Payload<?> payload)

Adds/Updates a file to the specified container

Specified by:

put in interface ObjectStorageObjectService

Parameters:

containerName - the container name

name - the name of the file

payload - the file payload

Returns:

the ETAG checksum

put

public String put(String containerName,
                  String name,
                  Payload<?> payload,
                  ObjectPutOptions options)

Adds/Updates a file to the specified container

Specified by:

put in interface ObjectStorageObjectService

Parameters:

containerName - the container name

name - the name of the file

payload - the file payload

options - extended options to associate with this object

Returns:

the ETAG checksum

delete

public ActionResponse delete(String containerName,
                             String name)

Description copied from interface: ObjectStorageObjectService

Deletes an Object from the specified container

Specified by:

delete in interface ObjectStorageObjectService

Parameters:

containerName - the container name

name - the name of the object (full path if directories are used)

Returns:

the action response

delete

public ActionResponse delete(ObjectLocation location)

Description copied from interface: ObjectStorageObjectService

Deletes an Object from the specified container

Specified by:

delete in interface ObjectStorageObjectService

Parameters:

location - location containing container name and object name

Returns:

the action response

delete

public ActionResponse delete(ObjectLocation location,
                             ObjectDeleteOptions options)

Description copied from interface: ObjectStorageObjectService

Deletes an Object from the specified container

Specified by:

delete in interface ObjectStorageObjectService

Parameters:

location - location containing container name and object name

options - the deleting options

Returns:

the action response

copy

public String copy(ObjectLocation source,
                   ObjectLocation dest)

Copies an object to another object in the object store

Specified by:

copy in interface ObjectStorageObjectService

Parameters:

source - the source container and object name

dest - the destination container and object name

Returns:

the ETAG checksum if successful

getMetadata

public Map<String,String> getMetadata(ObjectLocation location)

Description copied from interface: ObjectStorageObjectService

Gets the metadata for the specified object location

Specified by:

getMetadata in interface ObjectStorageObjectService

Parameters:

location - the object location

Returns:

Map of Key to Value metadata

getMetadata

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

Description copied from interface: ObjectStorageObjectService

See ObjectStorageObjectService.getMetadata(ObjectLocation)

Specified by:

getMetadata in interface ObjectStorageObjectService

Parameters:

containerName - the container name

name - the object name

Returns:

Map of Key to Value metadata

updateMetadata

public boolean updateMetadata(ObjectLocation location,
                              Map<String,String> metadata)

Description copied from interface: ObjectStorageObjectService

Creates or Updates the given metadata for the specified object location

Specified by:

updateMetadata in interface ObjectStorageObjectService

Parameters:

location - the location of the object to create/update metadata

metadata - the metadata

Returns:

true if successful

download

public DLPayload download(String containerName,
                          String name)

Description copied from interface: ObjectStorageObjectService

Retrieves the Payload for the data backing the given containerName and name

Specified by:

download in interface ObjectStorageObjectService

Parameters:

containerName - the container name

name - the object name

Returns:

the download payload

download

public DLPayload download(String containerName,
                          String name,
                          DownloadOptions options)

Description copied from interface: ObjectStorageObjectService

Retrieves the Payload for the data backing the given containerName and name

Specified by:

download in interface ObjectStorageObjectService

Parameters:

containerName - the container name

name - the object name

options - the download options

Returns:

the download payload

download

public DLPayload download(ObjectLocation location,
                          DownloadOptions options)

Description copied from interface: ObjectStorageObjectService

Retrieves the Payload for the data backing the given location

Specified by:

download in interface ObjectStorageObjectService

Parameters:

location - the object location

options - the download options

Returns:

the download payload