14.2.1.9. Event Handler

The following event handlers are known to eduMFA

• 14.2.1.9.1. Event Handler Base Class
  • BaseEventHandler
    • BaseEventHandler.actions
    • BaseEventHandler.allowed_positions
    • BaseEventHandler.check_condition()
    • BaseEventHandler.conditions
    • BaseEventHandler.description
    • BaseEventHandler.do()
    • BaseEventHandler.events
    • BaseEventHandler.identifier
• 14.2.1.9.2. User Notification Event Handler
  • UserNotificationEventHandler
    • UserNotificationEventHandler.actions
    • UserNotificationEventHandler.allowed_positions
    • UserNotificationEventHandler.description
    • UserNotificationEventHandler.do()
    • UserNotificationEventHandler.identifier

class edumfa.lib.event.EventConfiguration

This class is supposed to contain the event handling configuration during the Request. The currently defined events are fetched from the request-local config object.

property events

Shortcut for retrieving the currently defined event handlers from the request-local config object.

get_event(eventid)

Return the reduced list with the given eventid. This list should only have one element.

Parameters:

eventid (int or None) – id of the event

Returns:

list with one element

get_handled_events(eventname, position='post')

Return a list of the event handling definitions for the given eventname and the given position.

Parameters:

• eventname – The name of the event

• position – the position of the event definition

Returns:

edumfa.lib.event.delete_event(event_id)

Delete the event configuration with this given ID. :param event_id: The database ID of the event. :type event_id: int :return:

edumfa.lib.event.enable_event(event_id, enable=True)

Enable or disable the and event :param event_id: ID of the event :return:

class edumfa.lib.event.event(eventname, request, g)

This is the event decorator that calls the event handler in the handler module. This event decorator can be used at any API call

edumfa.lib.event.export_event(name=None)

Export given or all event configuration

edumfa.lib.event.get_handler_object(handlername)

Return an event handler object based on the Name of the event handler class

Parameters:

handlername – The identifier of the Handler Class

Returns:

edumfa.lib.event.import_event(data, name=None)

Import policy configuration

edumfa.lib.event.set_event(name=None, event=None, handlermodule=None, action=None, conditions=None, ordering=0, options=None, id=None, active=True, position='post')

Set an event handling configuration. This writes an entry to the database eventhandler.

Parameters:

• name – The name of the event definition

• event (basestring) – The name of the event to react on. Can be a single event or a comma separated list.

• handlermodule (basestring) – The identifier of the event handler module. This is an identifier string like “UserNotification”

• action (basestring) – The action to perform. This is an action defined by the handler module

• conditions (dict) – A condition. Only if this condition is met, the action is performed.

• ordering (integer) – An optional ordering of the event definitions.

• options (dict) – Additional options, that are needed as parameters for the action

• id (int) – The DB id of the event. If the id is given, the event is updated. Otherwise a new entry is generated.

• position (basestring) – The position of the event handler being “post” or “pre”

Returns:

The id of the event.