eoxserver.backends package

Submodules

eoxserver.backends.access module

eoxserver.backends.cache module

eoxserver.backends.component module

eoxserver.backends.config module

eoxserver.backends.interfaces module

class eoxserver.backends.interfaces.AbstractStorageInterface

Bases: object

name

Name of the storage implementation.

validate(url)

Validates the given storage locator and raises a django.core.exceptions.ValidationError if errors occurred.

class eoxserver.backends.interfaces.ConnectedStorageInterface

Bases: eoxserver.backends.interfaces.AbstractStorageInterface

Interface for storages that do not store “files” but provide access to data in a different fashion.

connect(url, location)

Return a connection string for a remote dataset residing on a storage specified by the given url and location.

Parameters:
  • url – the URL denoting the storage itself
  • location – the location of the file to retrieve on the storage
Returns:

a connection string to open the stream to actually retrieve data
class eoxserver.backends.interfaces.FileStorageInterface

Bases: eoxserver.backends.interfaces.AbstractStorageInterface

Interface for storages that provide access to files and allow the retrieval of those.

list_files(url, location)

Return a list of retrievable files available on the storage located at the specified URL and given location.

Parameters:
  • url – the URL denoting the storage itself
  • location – a template to find items on the storage
Returns:

an iterable of the storage contents under the specified location
retrieve(url, location, path)

Retrieve a remote file from the storage specified by the given url and location and store it to the given path. Storages that don’t need to actually retrieve and store files, just need to return a path to a local file instead of storing it under path.

Parameters:
  • url – the URL denoting the storage itself
  • location – the location of the file to retrieve on the storage
  • path – a local path where the file should be saved under; this is used as a hint
Returns:

the actual path where the file was stored; in some cases this can be different than the passed path
class eoxserver.backends.interfaces.PackageInterface

Bases: object

extract(package_filename, location, path)

Extract a file specified by the location from the package to the given path specification.

Parameters:
  • package_filename – the local filename of the package
  • location – a location within the package to be extracted
  • path – a local path where the file should be saved under; this is used as a hint
Returns:

the actual path where the file was stored; in some cases this can be different than the passed path
list_contents(package_filename, location_regex=None)

Return a list of item locations under the specified location in the given package.

Parameters:
  • package_filename – the local filename of the package
  • location_regex – a template to find items within the package
Returns:

an iterable of the package contents under the specified location
name

Name of the package implementation.

eoxserver.backends.middleware module

eoxserver.backends.models module

eoxserver.backends.testbase module

Module contents