io.openio.sds

Interface AdvancedClient

All Superinterfaces:

Client

All Known Implementing Classes:

DefaultClient

public interface AdvancedClient
extends Client

Method Summary

Modifier and Type	Method and Description
io.openio.sds.models.ContainerInfo	createContainer(io.openio.sds.models.OioUrl url, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,java.lang.String> system, RequestContext reqCtx) Create a container using the specified OioUrl.
io.openio.sds.models.ContainerInfo	createContainer(io.openio.sds.models.OioUrl url, java.util.Map<java.lang.String,java.lang.String> properties, RequestContext reqCtx) Create a container using the specified OioUrl.
io.openio.sds.models.ContainerInfo	createContainer(io.openio.sds.models.OioUrl url, RequestContext reqCtx) Create a container using the specified OioUrl.
void	deleteContainer(io.openio.sds.models.OioUrl url, RequestContext reqCtx) Delete the specified container
void	deleteContainerProperties(io.openio.sds.models.OioUrl url, java.util.List<java.lang.String> keys, RequestContext reqCtx) Deletes user properties from the specified container
void	deleteContainerProperties(io.openio.sds.models.OioUrl url, RequestContext reqCtx, java.lang.String... keys) Deletes user properties from the specified container
void	deleteObject(io.openio.sds.models.OioUrl url, java.lang.Long version, RequestContext reqCtx) Deprecated.
void	deleteObject(io.openio.sds.models.OioUrl url, io.openio.sds.models.ObjectDeletionOptions options, RequestContext reqCtx) Delete the specified object.
void	deleteObject(io.openio.sds.models.OioUrl url, RequestContext reqCtx) Delete the specified object.
void	deleteObjectProperties(io.openio.sds.models.OioUrl url, java.util.List<java.lang.String> keys, RequestContext reqCtx) Deletes the specified properties from the object
void	deleteObjectProperties(io.openio.sds.models.OioUrl url, java.lang.Long version, java.util.List<java.lang.String> keys, RequestContext reqCtx) Deletes the specified properties from the object
void	deleteObjectProperties(io.openio.sds.models.OioUrl url, java.lang.Long version, RequestContext reqCtx, java.lang.String... keys) Deletes the specified properties from the object
void	deleteObjectProperties(io.openio.sds.models.OioUrl url, RequestContext reqCtx, java.lang.String... keys) Deletes the specified properties from the object
java.io.InputStream	downloadObject(io.openio.sds.models.ObjectInfo oinf, io.openio.sds.models.Range range, RequestContext reqCtx) Get object data from a specified range.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getAllContainerProperties(io.openio.sds.models.OioUrl url, RequestContext reqCtx) Retrieve user properties and system properties of the specified container.
io.openio.sds.models.ContainerInfo	getContainerInfo(io.openio.sds.models.OioUrl url, RequestContext reqCtx) Return information about the specified container.
java.util.Map<java.lang.String,java.lang.String>	getContainerProperties(io.openio.sds.models.OioUrl url, RequestContext reqCtx) Retrieve user properties of the specified container.
io.openio.sds.models.NamespaceInfo	getNamespaceInfo(RequestContext reqCtx) Get OpenIO-SDS namespace configuration.
io.openio.sds.models.ObjectInfo	getObjectInfo(io.openio.sds.models.OioUrl url, java.lang.Long version, boolean loadProperties, RequestContext reqCtx) Returns information about the specified object
java.util.Map<java.lang.String,java.lang.String>	getObjectProperties(io.openio.sds.models.OioUrl url, java.lang.Long version, RequestContext reqCtx) Retrieve user properties of the specified object.
java.util.Map<java.lang.String,java.lang.String>	getObjectProperties(io.openio.sds.models.OioUrl url, RequestContext reqCtx) Retrieve user properties of the specified object.
io.openio.sds.models.ObjectList	listObjects(io.openio.sds.models.OioUrl url, io.openio.sds.models.ListOptions listOptions, RequestContext reqCtx) List objects available in the specified container.
io.openio.sds.models.ObjectInfo	putObject(io.openio.sds.models.OioUrl url, java.lang.Long size, java.io.File data, java.lang.Long version, java.util.Map<java.lang.String,java.lang.String> properties, RequestContext reqCtx) Deprecated.
io.openio.sds.models.ObjectInfo	putObject(io.openio.sds.models.OioUrl url, java.lang.Long size, java.io.File data, io.openio.sds.models.ObjectCreationOptions options, RequestContext reqCtx) Push an object into the OpenIO-SDS namespace.
io.openio.sds.models.ObjectInfo	putObject(io.openio.sds.models.OioUrl url, java.lang.Long size, java.io.InputStream data, java.lang.Long version, java.util.Map<java.lang.String,java.lang.String> properties, RequestContext reqCtx) Deprecated.
io.openio.sds.models.ObjectInfo	putObject(io.openio.sds.models.OioUrl url, java.lang.Long size, java.io.InputStream data, io.openio.sds.models.ObjectCreationOptions options, RequestContext reqCtx) Push an object into the OpenIO-SDS namespace.
void	setContainerProperties(io.openio.sds.models.OioUrl url, java.util.Map<java.lang.String,java.lang.String> props, boolean clear, java.util.Map<java.lang.String,java.lang.String> sys, RequestContext reqCtx) Set properties to the specified container.
void	setContainerProperties(io.openio.sds.models.OioUrl url, java.util.Map<java.lang.String,java.lang.String> props, boolean clear, RequestContext reqCtx) Set properties to the specified container.
void	setContainerProperties(io.openio.sds.models.OioUrl url, java.util.Map<java.lang.String,java.lang.String> props, java.util.Map<java.lang.String,java.lang.String> sys, RequestContext reqCtx) Set properties to the specified container.
void	setContainerProperties(io.openio.sds.models.OioUrl url, java.util.Map<java.lang.String,java.lang.String> props, RequestContext reqCtx) Set properties to the specified container.
void	setObjectProperties(io.openio.sds.models.OioUrl url, java.lang.Long version, java.util.Map<java.lang.String,java.lang.String> props, boolean clear, RequestContext reqCtx) Add properties to the specified object.
void	setObjectProperties(io.openio.sds.models.OioUrl url, java.lang.Long version, java.util.Map<java.lang.String,java.lang.String> props, RequestContext reqCtx) Add properties to the specified object.
void	setObjectProperties(io.openio.sds.models.OioUrl url, java.util.Map<java.lang.String,java.lang.String> props, boolean clear, RequestContext reqCtx) Add properties to the specified object.
void	setObjectProperties(io.openio.sds.models.OioUrl url, java.util.Map<java.lang.String,java.lang.String> props, RequestContext reqCtx) Add properties to the specified object.

Methods inherited from interface io.openio.sds.Client

createContainer, createContainer, createContainer, deleteContainer, deleteContainerProperties, deleteContainerProperties, deleteObject, deleteObject, deleteObject, deleteObjectProperties, deleteObjectProperties, deleteObjectProperties, deleteObjectProperties, downloadObject, downloadObject, getAllContainerProperties, getContainerInfo, getContainerProperties, getNamespaceInfo, getObjectInfo, getObjectInfo, getObjectInfo, getObjectInfo, getObjectProperties, getObjectProperties, listContainer, listObjects, putObject, putObject, putObject, putObject, putObject, putObject, putObject, putObject, putObject, putObject, setContainerProperties, setContainerProperties, setContainerProperties, setContainerProperties, setObjectProperties, setObjectProperties, setObjectProperties, setObjectProperties

Method Detail

getNamespaceInfo

io.openio.sds.models.NamespaceInfo getNamespaceInfo(RequestContext reqCtx)
                                             throws io.openio.sds.exceptions.OioException

Get OpenIO-SDS namespace configuration.

Parameters:

reqCtx - Common parameters to all requests

Returns:

the namespace configuration

Throws:

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

createContainer

io.openio.sds.models.ContainerInfo createContainer(io.openio.sds.models.OioUrl url,
                                                   RequestContext reqCtx)
                                            throws io.openio.sds.exceptions.OioException

Create a container using the specified OioUrl. OioUrl objects are built by using OioUrl.url(String, String) method, then you have to specify the name of the account to use and the name of the future container.

The container is available when the returned future is completed.

Parameters:

url - the URL of the container

reqCtx - common parameters to all requests

Returns:

a ContainerInfo with information about the created container

Throws:

io.openio.sds.exceptions.ContainerExistException - if the specified container is alreay present

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

createContainer

io.openio.sds.models.ContainerInfo createContainer(io.openio.sds.models.OioUrl url,
                                                   java.util.Map<java.lang.String,java.lang.String> properties,
                                                   RequestContext reqCtx)
                                            throws io.openio.sds.exceptions.OioException

Create a container using the specified OioUrl. OioUrl objects are built by using OioUrl.url(String, String) method, then you have to specify the name of the account to use and the name of the future container.

The container is available when the returned future is completed.

Parameters:

url - the URL of the container

properties - the user properties to set to the container.

reqCtx - common parameters to all requests

Returns:

a ContainerInfo with information about the created container

Throws:

io.openio.sds.exceptions.ContainerExistException - if the specified container is alreay present

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

createContainer

io.openio.sds.models.ContainerInfo createContainer(io.openio.sds.models.OioUrl url,
                                                   java.util.Map<java.lang.String,java.lang.String> properties,
                                                   java.util.Map<java.lang.String,java.lang.String> system,
                                                   RequestContext reqCtx)
                                            throws io.openio.sds.exceptions.OioException

Create a container using the specified OioUrl. OioUrl objects are built by using OioUrl.url(String, String) method, then you have to specify the name of the account to use and the name of the future container.

The container is available when the returned future is completed.

Parameters:

url - the URL of the container

properties - the user properties to set to the container.

system - the system properties to set to the container.

reqCtx - common parameters to all requests

Returns:

a ContainerInfo with information about the created container

Throws:

io.openio.sds.exceptions.ContainerExistException - if the specified container is alreay present

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

getContainerInfo

io.openio.sds.models.ContainerInfo getContainerInfo(io.openio.sds.models.OioUrl url,
                                                    RequestContext reqCtx)
                                             throws io.openio.sds.exceptions.OioException

Return information about the specified container.

Parameters:

url - the URL of the container

reqCtx - common parameters to all requests

Returns:

a ContainerInfo with information about the created container

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

listObjects

io.openio.sds.models.ObjectList listObjects(io.openio.sds.models.OioUrl url,
                                            io.openio.sds.models.ListOptions listOptions,
                                            RequestContext reqCtx)
                                     throws io.openio.sds.exceptions.OioException

List objects available in the specified container.

Parameters:

url - the url of the container

listOptions - the listing option

reqCtx - common parameters to all requests

Returns:

the ObjectList

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

Since:

1.0.0

deleteContainer

void deleteContainer(io.openio.sds.models.OioUrl url,
                     RequestContext reqCtx)
              throws io.openio.sds.exceptions.OioException

Delete the specified container

Parameters:

url - the URL of the container

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ContainerNotEmptyException - if the specified container isn't empty

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

setContainerProperties

void setContainerProperties(io.openio.sds.models.OioUrl url,
                            java.util.Map<java.lang.String,java.lang.String> props,
                            RequestContext reqCtx)
                     throws io.openio.sds.exceptions.OioException

Set properties to the specified container.

Parameters:

url - the URL of the container to set properties

props - the properties to set

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

setContainerProperties

void setContainerProperties(io.openio.sds.models.OioUrl url,
                            java.util.Map<java.lang.String,java.lang.String> props,
                            boolean clear,
                            RequestContext reqCtx)
                     throws io.openio.sds.exceptions.OioException

Set properties to the specified container.

Parameters:

url - the URL of the container to set properties

props - the properties to set

clear - clear previous properties

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

setContainerProperties

void setContainerProperties(io.openio.sds.models.OioUrl url,
                            java.util.Map<java.lang.String,java.lang.String> props,
                            java.util.Map<java.lang.String,java.lang.String> sys,
                            RequestContext reqCtx)
                     throws io.openio.sds.exceptions.OioException

Set properties to the specified container.

Parameters:

url - the URL of the container to set properties

props - the properties to set

sys - the system properties to set

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

setContainerProperties

void setContainerProperties(io.openio.sds.models.OioUrl url,
                            java.util.Map<java.lang.String,java.lang.String> props,
                            boolean clear,
                            java.util.Map<java.lang.String,java.lang.String> sys,
                            RequestContext reqCtx)
                     throws io.openio.sds.exceptions.OioException

Set properties to the specified container.

Parameters:

url - the URL of the container to set properties

props - the properties to set

clear - clear previous properties

sys - the system properties to set

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

getContainerProperties

java.util.Map<java.lang.String,java.lang.String> getContainerProperties(io.openio.sds.models.OioUrl url,
                                                                        RequestContext reqCtx)
                                                                 throws io.openio.sds.exceptions.OioException

Retrieve user properties of the specified container.

Parameters:

url - the url of the container

reqCtx - common parameters to all requests

Returns:

the user properties found on the container

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

getAllContainerProperties

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getAllContainerProperties(io.openio.sds.models.OioUrl url,
                                                                                                           RequestContext reqCtx)
                                                                                                    throws io.openio.sds.exceptions.OioException

Retrieve user properties and system properties of the specified container.

Parameters:

url - the url of the container

reqCtx - common parameters to all requests

Returns:

the user properties and system properties found on the container

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

deleteContainerProperties

void deleteContainerProperties(io.openio.sds.models.OioUrl url,
                               RequestContext reqCtx,
                               java.lang.String... keys)
                        throws io.openio.sds.exceptions.OioException

Deletes user properties from the specified container

Parameters:

url - the url of the container

reqCtx - common parameters to all requests

keys - the property keys to drop

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

deleteContainerProperties

void deleteContainerProperties(io.openio.sds.models.OioUrl url,
                               java.util.List<java.lang.String> keys,
                               RequestContext reqCtx)
                        throws io.openio.sds.exceptions.OioException

Deletes user properties from the specified container

Parameters:

url - the url of the container

keys - the property keys to drop

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

putObject

@Deprecated
io.openio.sds.models.ObjectInfo putObject(io.openio.sds.models.OioUrl url,
                                                      java.lang.Long size,
                                                      java.io.InputStream data,
                                                      java.lang.Long version,
                                                      java.util.Map<java.lang.String,java.lang.String> properties,
                                                      RequestContext reqCtx)
                                               throws io.openio.sds.exceptions.OioException

Deprecated.

Push an object into the OpenIO-SDS namespace.

Parameters:

url - the URL of the object to create

size - the size of the object

data - the InputStream to read the data from

version - the version of content to upload

properties - the properties to set to the object. Note that the properties are case insensitive and will always be returned in lower case.

reqCtx - Common parameters to all requests

Returns:

information about the uploaded object

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectExistException - if the specified object already exist in the container

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

putObject

io.openio.sds.models.ObjectInfo putObject(io.openio.sds.models.OioUrl url,
                                          java.lang.Long size,
                                          java.io.InputStream data,
                                          io.openio.sds.models.ObjectCreationOptions options,
                                          RequestContext reqCtx)
                                   throws io.openio.sds.exceptions.OioException

Push an object into the OpenIO-SDS namespace.

Parameters:

url - the URL of the object to create

size - the size of the object

data - the InputStream to read the data from

options - the options of content to upload

reqCtx - Common parameters to all requests

Returns:

information about the uploaded object

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectExistException - if the specified object already exist in the container

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

putObject

@Deprecated
io.openio.sds.models.ObjectInfo putObject(io.openio.sds.models.OioUrl url,
                                                      java.lang.Long size,
                                                      java.io.File data,
                                                      java.lang.Long version,
                                                      java.util.Map<java.lang.String,java.lang.String> properties,
                                                      RequestContext reqCtx)
                                               throws io.openio.sds.exceptions.OioException

Deprecated.

Push an object into the OpenIO-SDS namespace.

Parameters:

url - the URL of the object to create

reqCtx - Common parameters to all requests

size - the size of the object

data - the file to read the data from

version - the version of content to upload

properties - the properties to set to the object. Note that the properties are case insensitive and will always be returned in lower case.

Returns:

information about the uploaded object

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

putObject

io.openio.sds.models.ObjectInfo putObject(io.openio.sds.models.OioUrl url,
                                          java.lang.Long size,
                                          java.io.File data,
                                          io.openio.sds.models.ObjectCreationOptions options,
                                          RequestContext reqCtx)
                                   throws io.openio.sds.exceptions.OioException

Push an object into the OpenIO-SDS namespace.

Parameters:

url - the URL of the object to create

reqCtx - Common parameters to all requests

size - the size of the object

data - the file to read the data from

options - the options of content to upload

Returns:

information about the uploaded object

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

getObjectInfo

io.openio.sds.models.ObjectInfo getObjectInfo(io.openio.sds.models.OioUrl url,
                                              java.lang.Long version,
                                              boolean loadProperties,
                                              RequestContext reqCtx)
                                       throws io.openio.sds.exceptions.OioException

Returns information about the specified object

Parameters:

url - the URL of the object

version - the version to get (could be null to get latest version)

loadProperties - if true, an additional request is performed to get object properties assigned to the specified object

reqCtx - common parameters to all requests

Returns:

an ObjectInfo

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

downloadObject

java.io.InputStream downloadObject(io.openio.sds.models.ObjectInfo oinf,
                                   io.openio.sds.models.Range range,
                                   RequestContext reqCtx)

Get object data from a specified range.

Parameters:

oinf - the information about object to download

range - the wanted data range

reqCtx - common parameters to all requests

Returns:

the data in InputStream format

Throws:

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

deleteObject

void deleteObject(io.openio.sds.models.OioUrl url,
                  RequestContext reqCtx)
           throws io.openio.sds.exceptions.OioException

Delete the specified object.

Parameters:

url - the URL of the object to delete

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

deleteObject

@Deprecated
void deleteObject(io.openio.sds.models.OioUrl url,
                              java.lang.Long version,
                              RequestContext reqCtx)
                       throws io.openio.sds.exceptions.OioException

Deprecated.

Delete the specified object.

Parameters:

url - the URL of the object to delete

version - the version to delete (could be null to delete latest version)

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

deleteObject

void deleteObject(io.openio.sds.models.OioUrl url,
                  io.openio.sds.models.ObjectDeletionOptions options,
                  RequestContext reqCtx)
           throws io.openio.sds.exceptions.OioException

Delete the specified object.

Parameters:

url - the URL of the object to delete

options - the options of object to delete

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

setObjectProperties

void setObjectProperties(io.openio.sds.models.OioUrl url,
                         java.util.Map<java.lang.String,java.lang.String> props,
                         RequestContext reqCtx)
                  throws io.openio.sds.exceptions.OioException

Add properties to the specified object. The properties must be prefixed with "user." and this prefix will be stored, and finally used to query the parameters later.

Parameters:

url - the URL of the object

props - the properties to set

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

setObjectProperties

void setObjectProperties(io.openio.sds.models.OioUrl url,
                         java.lang.Long version,
                         java.util.Map<java.lang.String,java.lang.String> props,
                         RequestContext reqCtx)
                  throws io.openio.sds.exceptions.OioException

Add properties to the specified object. The properties must be prefixed with "user." and this prefix will be stored, and finally used to query the parameters later.

Parameters:

url - the URL of the object

version - the version to manipulate (could be null to manipulate latest version)

props - the properties to set

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

setObjectProperties

void setObjectProperties(io.openio.sds.models.OioUrl url,
                         java.util.Map<java.lang.String,java.lang.String> props,
                         boolean clear,
                         RequestContext reqCtx)
                  throws io.openio.sds.exceptions.OioException

Add properties to the specified object. The properties must be prefixed with "user." and this prefix will be stored, and finally used to query the parameters later.

Parameters:

url - the URL of the object

props - the properties to set

clear - clear previous properties

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

setObjectProperties

void setObjectProperties(io.openio.sds.models.OioUrl url,
                         java.lang.Long version,
                         java.util.Map<java.lang.String,java.lang.String> props,
                         boolean clear,
                         RequestContext reqCtx)
                  throws io.openio.sds.exceptions.OioException

Add properties to the specified object. The properties must be prefixed with "user." and this prefix will be stored, and finally used to query the parameters later.

Parameters:

url - the URL of the object

version - the version to manipulate (could be null to manipulate latest version)

props - the properties to set

clear - clear previous properties

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

getObjectProperties

java.util.Map<java.lang.String,java.lang.String> getObjectProperties(io.openio.sds.models.OioUrl url,
                                                                     RequestContext reqCtx)
                                                              throws io.openio.sds.exceptions.OioException

Retrieve user properties of the specified object.

Parameters:

url - the URL of the object

reqCtx - common parameters to all requests

Returns:

the user properties (i.e. prefixed with "user.") found on the object

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

getObjectProperties

java.util.Map<java.lang.String,java.lang.String> getObjectProperties(io.openio.sds.models.OioUrl url,
                                                                     java.lang.Long version,
                                                                     RequestContext reqCtx)
                                                              throws io.openio.sds.exceptions.OioException

Retrieve user properties of the specified object.

Parameters:

url - the URL of the object

version - the version to manipulate (could be null to manipulate latest version)

reqCtx - common parameters to all requests

Returns:

the user properties (i.e. prefixed with "user.") found on the object

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

deleteObjectProperties

void deleteObjectProperties(io.openio.sds.models.OioUrl url,
                            RequestContext reqCtx,
                            java.lang.String... keys)
                     throws io.openio.sds.exceptions.OioException

Deletes the specified properties from the object

Parameters:

url - the url of the object

reqCtx - common parameters to all requests

keys - the property keys to drop

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

deleteObjectProperties

void deleteObjectProperties(io.openio.sds.models.OioUrl url,
                            java.lang.Long version,
                            RequestContext reqCtx,
                            java.lang.String... keys)
                     throws io.openio.sds.exceptions.OioException

Deletes the specified properties from the object

Parameters:

url - the url of the object

version - the version to manipulate (could be null to manipulate latest version)

reqCtx - common parameters to all requests

keys - the property keys to drop

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

deleteObjectProperties

void deleteObjectProperties(io.openio.sds.models.OioUrl url,
                            java.util.List<java.lang.String> keys,
                            RequestContext reqCtx)
                     throws io.openio.sds.exceptions.OioException

Deletes the specified properties from the object

Parameters:

url - the url of the object

keys - the property keys to drop

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException

deleteObjectProperties

void deleteObjectProperties(io.openio.sds.models.OioUrl url,
                            java.lang.Long version,
                            java.util.List<java.lang.String> keys,
                            RequestContext reqCtx)
                     throws io.openio.sds.exceptions.OioException

Deletes the specified properties from the object

Parameters:

url - the url of the object

version - the version to manipulate (could be null to manipulate latest version)

keys - the property keys to drop

reqCtx - common parameters to all requests

Throws:

io.openio.sds.exceptions.ContainerNotFoundException - if the specified container doesn't exist

io.openio.sds.exceptions.ObjectNotFoundException - if the specified object doesn't exist

io.openio.sds.exceptions.OioSystemException - if any error occurs during request execution

io.openio.sds.exceptions.OioException