acme.plugins.services.GroupManager.GroupManager

class documentation

class GroupManager:

Manager for the CSE's group service.

Method	`configure`	Configure the GroupManager with the provided configuration.
Method	`foptRequest`	Handle requests to a <`acme.resources.GRP.GRP`>'s <`GRP_FOPT`> fanOutPoint. This method might be called recursivly, in case there are groups in groups.
Method	`handleDeleteEvent`	Handle a CSE-internal delete event (ie. whenever a resource is deleted). Check whether the deleted resource is a member of a group. If yes, then remove the member. This method is called by the `EventManager`...
Method	`restart`	Restart the Group Manager.
Method	`start`	Initialization of the GroupManager.
Method	`stop`	Shutdown the GroupManager.
Method	`validate`	Validate the GroupManager configuration.
Method	`validateGroup`	Validate a group and its members (privileges and attribute).
Class Variable	`dispatcher`	Injected Dispatcher instance.
Class Variable	`factory`	Injected Factory instance.
Class Variable	`request`	Injected Request manager instance.
Class Variable	`security`	Injected Security manager instance.
Class Variable	`storage`	Injected Storage instance.
Method	`_checkMembersAndPrivileges`	Internally check a group's member resources and privileges.

@configure

def configure(self, config: Configuration): ¶

Configure the GroupManager with the provided configuration.

Parameters
config:`Configuration`	The configuration to apply.

def foptRequest(self, operation: Operation, fopt: GRP_FOPT, request: CSERequest, id: str, originator: str) -> Result: ¶

Handle requests to a <acme.resources.GRP.GRP>'s <GRP_FOPT> fanOutPoint. This method might be called recursivly, in case there are groups in groups.

Parameters
operation:`Operation`	The operation type to perform on the group.
fopt:`GRP_FOPT`	The <`GRP_FOPT`> virtual resource.
request:`CSERequest`	The request to perform on the <`GRP_FOPT`>.
id:`str`	The original target resource ID.
originator:`str`	The request's originator.

Returns
`Result`	`Result` instance.

@onEvent(eventManager.deleteResource)

def handleDeleteEvent(self, eventData: EventData): ¶

Handle a CSE-internal delete event (ie. whenever a resource is deleted). Check whether the deleted resource is a member of a group. If yes, then remove the member. This method is called by the EventManager.

Parameters
eventData:`EventData`	The event data containing the deleted resource in `EventData.payload`.

@restart

def restart(self): ¶

Restart the Group Manager.

@start

def start(self): ¶

Initialization of the GroupManager.

@stop

def stop(self) -> bool: ¶

Shutdown the GroupManager.

Returns
`bool`	True when shutdown is complete.

@validate

def validate(self, config: Configuration): ¶

Validate the GroupManager configuration.

Parameters
config:`Configuration`	The configuration to validate.

def validateGroup(self, group: Resource, originator: str): ¶

Validate a group and its members (privileges and attribute).

Parameters
group:`Resource`	The <group> resource.
originator:`str`	The request's originator.

Returns
`Result` instance.

dispatcher: Dispatcher = ¶

Injected Dispatcher instance.

factory: Factory = ¶

Injected Factory instance.

request: RequestManager = ¶

Injected Request manager instance.

security: SecurityManager = ¶

Injected Security manager instance.

storage: Storage = ¶

Injected Storage instance.

def _checkMembersAndPrivileges(self, group: Resource, originator: str): ¶

Internally check a group's member resources and privileges.

Parameters
group:`Resource`	The group resource.
originator:`str`	The request's originator.

Returns
`Result` object with the status of the operation.