crossbar.master.mrealm.metadata

Attributes

Exceptions

ObjectModified

Thrown when an object is to be updated, but was modified in the meantime.

Classes

Documentation

FIXME.

MetadataManager

The Metadata Manager manages metadata on arbitrary other objects in

Module Contents

class Documentation[source]

Bases: object

FIXME.

marshal()[source]
META_DOC_OTYPE_TO_SLOT = None[source]
class MetadataManager(session, db, schema)[source]

Bases: object

The Metadata Manager manages metadata on arbitrary other objects in the management realm database.

For example, it allows to attach Tags to Node, WebCluster or WebService objects.

The metadata services exposed include:

  • Tags

  • Documentation

  • Comments

_mrealm_oid[source]
_prefix = None[source]
_session[source]
_started = None[source]
add_docs(otype, oid, docs, details=None)[source]
Parameters:
  • oid

  • docs

  • details

Returns:

db[source]
delete_docs(oid, details=None)[source]
Parameters:
  • oid

  • details

Returns:

get_docs(otype, oid, details=None)[source]
Parameters:
  • otype (str) – Type of object to return documentation for.

  • oid – OID of the object to return documentation for.

  • details

Returns:

Documentation object,

log = None[source]
otype_to_slot[source]
schema[source]
start(prefix)[source]

Start the Metadata manager.

Returns:

stop()[source]

Stop the (currently running) Web-cluster manager.

Returns:

exception ObjectModified[source]

Bases: Exception

Thrown when an object is to be updated, but was modified in the meantime.

This is detected by matching the “modified” attribute, which is a timestamp of type integer with ns since Posix epoch (1970/1/1 UTC)