eoxserver.backends.storages package

Submodules

eoxserver.backends.storages.ftp module

eoxserver.backends.storages.http module

eoxserver.backends.storages.local module

eoxserver.backends.storages.rasdaman module

Module contents

class eoxserver.backends.storages.BaseStorageHandler

Bases: object

Storage Handlers must conform to the context manager protocol

allows_child_storages = False

allows_parent_storage = False

get_vsi_env()

get_vsi_path(location)

Get the VSI file path for the file specified by location. This path can be used in GDAL based APIs to directly adress files.

is_local = False

list_files(glob_pattern=None)

List the files in that storage, optionally filtered by a glob. Should be implemented for storages dealing with files, when possible.

name = None

retrieve(location, path)

Retrieve the file specified by location under the given local path. The path is only a hint, when a string is returned, this indicates that the file was instead stored in that location. Should be implemented by storage handlers that deal with files or similar objects.

classmethod test(locator)

Check if a locator refers to a storage that can be handled by this handler class.

class eoxserver.backends.storages.DirectoryStorageHandler(dirpath, streaming)

Bases: BaseStorageHandler

allows_child_storages = True

allows_parent_storage = True

get_vsi_path(location)

Get the VSI file path for the file specified by location. This path can be used in GDAL based APIs to directly adress files.

is_local = True

list_files(glob_pattern=None)

List the files in that storage, optionally filtered by a glob. Should be implemented for storages dealing with files, when possible.

name = 'directory'

retrieve(location, path)

Retrieve the file specified by location under the given local path. The path is only a hint, when a string is returned, this indicates that the file was instead stored in that location. Should be implemented by storage handlers that deal with files or similar objects.

classmethod test(locator)

Check if a locator refers to a storage that can be handled by this handler class.

class eoxserver.backends.storages.FTPStorageHandler(url, streaming)

Bases: BaseStorageHandler

allows_parent_storage = False

get_vsi_path(location)

Get the VSI file path for the file specified by location. This path can be used in GDAL based APIs to directly adress files.

list_files(location, glob_pattern=None)

List the files in that storage, optionally filtered by a glob. Should be implemented for storages dealing with files, when possible.

name = 'FTP'

retrieve(location, path)

Retrieve the file specified by location under the given local path. The path is only a hint, when a string is returned, this indicates that the file was instead stored in that location. Should be implemented by storage handlers that deal with files or similar objects.

classmethod test(locator)

Check if a locator refers to a storage that can be handled by this handler class.

class eoxserver.backends.storages.HTTPStorageHandler(url, streaming)

Bases: BaseStorageHandler

allows_child_storages = True

allows_parent_storage = False

get_vsi_path(location)

Get the VSI file path for the file specified by location. This path can be used in GDAL based APIs to directly adress files.

name = 'HTTP'

retrieve(location, path)

Retrieve the file specified by location under the given local path. The path is only a hint, when a string is returned, this indicates that the file was instead stored in that location. Should be implemented by storage handlers that deal with files or similar objects.

classmethod test(locator)

Check if a locator refers to a storage that can be handled by this handler class.

class eoxserver.backends.storages.S3StorageHandler(url, streaming)

Bases: BaseStorageHandler

allows_child_storages = True

allows_parent_storage = False

get_vsi_path(location)

Get the VSI file path for the file specified by location. This path can be used in GDAL based APIs to directly adress files.

list_files(location, glob_pattern=None)

List the files in that storage, optionally filtered by a glob. Should be implemented for storages dealing with files, when possible.

name = 'S3'

retrieve(location, path)

Retrieve the file specified by location under the given local path. The path is only a hint, when a string is returned, this indicates that the file was instead stored in that location. Should be implemented by storage handlers that deal with files or similar objects.

classmethod test(locator)

Check if a locator refers to a storage that can be handled by this handler class.

class eoxserver.backends.storages.SwiftStorageHandler(url, streaming)

Bases: BaseStorageHandler

allows_child_storages = True

allows_parent_storage = False

get_vsi_path(location)

Get the VSI file path for the file specified by location. This path can be used in GDAL based APIs to directly adress files.

list_files(location, glob_pattern=None)

List the files in that storage, optionally filtered by a glob. Should be implemented for storages dealing with files, when possible.

name = 'swift'

retrieve(location, path)

Retrieve the file specified by location under the given local path. The path is only a hint, when a string is returned, this indicates that the file was instead stored in that location. Should be implemented by storage handlers that deal with files or similar objects.

classmethod test(locator)

Check if a locator refers to a storage that can be handled by this handler class.

class eoxserver.backends.storages.TARStorageHandler(package_filename, streaming)

Bases: BaseStorageHandler

Implementation of the storage interface for ZIP storages.

allows_child_storages = True

allows_parent_storage = True

get_vsi_path(location)

Get the VSI file path for the file specified by location. This path can be used in GDAL based APIs to directly adress files.

is_local = True

list_files(glob_pattern=None)

List the files in that storage, optionally filtered by a glob. Should be implemented for storages dealing with files, when possible.

name = 'TAR'

retrieve(location, path)

Retrieve the file specified by location under the given local path. The path is only a hint, when a string is returned, this indicates that the file was instead stored in that location. Should be implemented by storage handlers that deal with files or similar objects.

classmethod test(locator)

Check if a locator refers to a storage that can be handled by this handler class.

class eoxserver.backends.storages.ZIPStorageHandler(package_filename, streaming)

Bases: BaseStorageHandler

Implementation of the storage interface for ZIP storages.

allows_child_storages = True

allows_parent_storage = True

get_vsi_path(location)

Get the VSI file path for the file specified by location. This path can be used in GDAL based APIs to directly adress files.

is_local = True

list_files(glob_pattern=None)

List the files in that storage, optionally filtered by a glob. Should be implemented for storages dealing with files, when possible.

name = 'ZIP'

retrieve(location, path)

Retrieve the file specified by location under the given local path. The path is only a hint, when a string is returned, this indicates that the file was instead stored in that location. Should be implemented by storage handlers that deal with files or similar objects.

classmethod test(locator)

Check if a locator refers to a storage that can be handled by this handler class.

eoxserver.backends.storages.get_handler_by_test(locator)

Test the given locator with the configured storage handlers and return the stora

eoxserver.backends.storages.get_handler_class_by_name(name)

eoxserver.backends.storages.get_handler_class_for_model(storage_model)

eoxserver.backends.storages.get_handler_for_model(storage_model)

eoxserver.backends.storages.get_handlers()