flumotion.manager.base.ManagerHeaven

Package flumotion :: Package manager :: Module base :: Class ManagerHeaven

[show private | hide private]

Class ManagerHeaven

             Loggable --+
                        |
Jellyable --+           |
            |           |
 Serializable --+       |
                |       |
    Referenceable --+   |
                    |   |
                 Root --+
                        |
                       ManagerHeaven

Known Subclasses:: AdminHeaven, ComponentHeaven, WorkerHeaven

I am a base class for heavens in the manager.

Method Summary
	`__init__(self, vishnu)`
`flumotion.manager.base.ManagerAvatar`	`createAvatar(self, avatarId, remoteIdentity)` Create a new avatar and manage it.
`ManagerAvatar`	`getAvatar(self, avatarId)` Get the avatar with the given id.
list of `ManagerAvatar`	`getAvatars(self)` Get all avatars in this heaven.
bool	`hasAvatar(self, avatarId)` Check if a component with that name is registered.
	`removeAvatar(self, avatarId)` Stop managing the given avatar.
Inherited from Root
	`rootObject(self, broker)` A `pb.BrokerFactory` is requesting to publish me as a root object.
Inherited from Referenceable
	`jellyFor(self, jellier)` (internal)
	`remoteMessageReceived(self, broker, message, args, kw)` A remote message has been received.
Inherited from Serializable
	`processUniqueID(self)` Return an ID which uniquely represents this object for this process.
Inherited from Jellyable
	`getStateFor(self, jellier)`
Inherited from Loggable
	`debug(self, *args)` Log a debug message.
dict	`doLog(self, level, where, format, args, *kwargs)` Log a message at the given level, with the possibility of going higher up in the stack.
	`error(self, *args)` Log an error.
	`info(self, *args)` Log an informational message.
	`log(self, *args)` Log a log message.
	`logFunction(self, *args)` Overridable log function.
	`logObjectName(self)` Overridable object name function.
	`warning(self, *args)` Log a warning.
	`warningFailure(self, failure, swallow)` Log a warning about a Failure.

Instance Variable Summary
dict of str -> `ManagerAvatar`	`avatars`: a dict of avatarId -> Avatar
`flumotion.manager.manager.Vishnu`	`vishnu`: the Vishnu in control of all the heavens

Class Variable Summary
`Implements`	`__implemented__` = `<implementedBy flumotion.manager.base....`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
`NoneType`	`avatarClass`: the class object this heaven instantiates avatars from.
Inherited from Referenceable
`NoneType`	`perspective` = None
Inherited from Jellyable
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
Inherited from Loggable
`str`	`logCategory`: Implementors can provide a category to log their messages under.

Method Details

init(self, vishnu)
(Constructor)

Parameters:: vishnu - the Vishnu in control of all the heavens
(type=flumotion.manager.manager.Vishnu)

createAvatar(self, avatarId, remoteIdentity)

Create a new avatar and manage it.

Parameters:: avatarId - id of the avatar to create
(type=str); remoteIdentity - the manager-side representation of the remote identity
(type=flumotion.common.identity.RemoteIdentity)

Returns:: a new avatar for the client
(type=flumotion.manager.base.ManagerAvatar)

getAvatar(self, avatarId)

Get the avatar with the given id.

Parameters:: avatarId - id of the avatar to get
(type=str)

Returns:: the avatar with the given id
(type=ManagerAvatar)

getAvatars(self)

Get all avatars in this heaven.

Returns:: a list of all avatars in this heaven
(type=list of ManagerAvatar)

hasAvatar(self, avatarId)

Check if a component with that name is registered.

Parameters:: avatarId - id of the avatar to check
(type=str)

Returns:: True if an avatar with that id is registered
(type=bool)

removeAvatar(self, avatarId)

Stop managing the given avatar.

Parameters:: avatarId - id of the avatar to remove
(type=str)

Instance Variable Details

avatars

a dict of avatarId -> Avatar

Type:: dict of str -> ManagerAvatar

vishnu

the Vishnu in control of all the heavens

Type:: flumotion.manager.manager.Vishnu

Class Variable Details

implemented

Type:: Implements
Value:: <implementedBy flumotion.manager.base.ManagerHeaven>

provides

Type:: ClassProvides
Value:: <zope.interface.declarations.ClassProvides object at 0x2ad267cda790>

avatarClass

the class object this heaven instantiates avatars from. To be set in subclass.

Type:: NoneType
Value:: None

Generated by Epydoc 2.1 on Sun Oct 26 16:39:16 2008

http://epydoc.sf.net