com.huawei.openstack4j.api.storage.ObjectStorageObjectService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openstack4j Show documentation
Show all versions of openstack4j Show documentation
Huawei Cloud Open API SDK for Java
/*******************************************************************************
* Copyright 2016 ContainX and OpenStack4j
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*******************************************************************************/
package com.huawei.openstack4j.api.storage;
import java.util.List;
import java.util.Map;
import com.huawei.openstack4j.common.RestService;
import com.huawei.openstack4j.model.common.ActionResponse;
import com.huawei.openstack4j.model.common.DLPayload;
import com.huawei.openstack4j.model.common.Payload;
import com.huawei.openstack4j.model.storage.block.options.DownloadOptions;
import com.huawei.openstack4j.model.storage.object.SwiftObject;
import com.huawei.openstack4j.model.storage.object.options.ObjectDeleteOptions;
import com.huawei.openstack4j.model.storage.object.options.ObjectListOptions;
import com.huawei.openstack4j.model.storage.object.options.ObjectLocation;
import com.huawei.openstack4j.model.storage.object.options.ObjectPutOptions;
/**
* A service responsible for maintaining directory and file objects within containers for
* an Object Service within OpenStack
*
* @author Jeremy Unruh
*/
public interface ObjectStorageObjectService extends RestService {
/**
* Lists all objects for the given container name
*
* @param containerName the container name
* @return List of File objects including Directories
*/
List list(String containerName);
/**
* Lists all objects for the given container name and list options
*
* @param containerName the container name
* @param options additional filter based options
* @return List of File objects including Directories
*/
List list(String containerName, ObjectListOptions options);
/**
* Gets the specified object based on the ObjectLocation {@code location}
*
* @param location the object location
* @return SwiftObject or null if not found
*/
SwiftObject get(ObjectLocation location);
/**
* Gets the specified object based on the {@code containerName} and {@code name} of the object
*
* @param containerName the objects container name
* @param name the name of the object
* @return SwiftObject or null if not found
*/
SwiftObject get(String containerName, String name);
/**
* Adds/Updates a file to the specified container
*
* @param containerName the container name
* @param name the name of the file
* @param payload the file payload
* @return the ETAG checksum
*/
String put(String containerName, String name, Payload payload);
/**
* Adds/Updates a file to the specified container
*
* @param containerName the container name
* @param name the name of the file
* @param payload the file payload
* @param options extended options to associate with this object
* @return the ETAG checksum
*/
String put(String containerName, String name, Payload payload, ObjectPutOptions options);
/**
* Retrieves the Payload for the data backing the given {@code containerName} and {@code name}
*
* @param containerName the container name
* @param name the object name
* @return the download payload
*/
DLPayload download(String containerName, String name);
/**
* Retrieves the Payload for the data backing the given {@code containerName} and {@code name}
*
* @param containerName the container name
* @param name the object name
* @param options the download options
* @return the download payload
*/
DLPayload download(String containerName, String name, DownloadOptions options);
/**
* Retrieves the Payload for the data backing the given {@code location}
*
* @param location the object location
* @param options the download options
* @return the download payload
*/
DLPayload download(ObjectLocation location, DownloadOptions options);
/**
* Deletes an Object from the specified container
*
* @param containerName the container name
* @param name the name of the object (full path if directories are used)
* @return the action response
*/
ActionResponse delete(String containerName, String name);
/**
* Deletes an Object from the specified container
*
* @param location location containing container name and object name
* @return the action response
*/
ActionResponse delete(ObjectLocation location);
/**
* Deletes an Object from the specified container
*
* @param location location containing container name and object name
* @param options the deleting options
* @return the action response
*/
ActionResponse delete(ObjectLocation location, ObjectDeleteOptions options);
/**
* Copies an object to another object in the object store
*
* @param source the source container and object name
* @param dest the destination container and object name
* @return the ETAG checksum if successful
*/
String copy(ObjectLocation source, ObjectLocation dest);
/**
* Gets the metadata for the specified object location
* @param location the object location
* @return Map of Key to Value metadata
*/
Map getMetadata(ObjectLocation location);
/**
* See {@link #getMetadata(ObjectLocation)}
*
* @param containerName the container name
* @param name the object name
* @return Map of Key to Value metadata
*/
Map getMetadata(String containerName, String name);
/**
* Creates or Updates the given metadata for the specified object location
*
* @param location the location of the object to create/update metadata
* @param metadata the metadata
* @return true if successful
*/
boolean updateMetadata(ObjectLocation location, Map metadata);
}