def create(self, notifier_type_id, notifier_config, event_types):
"""
Creates a new event listener in the server. The listener will listen
for events of the given types and use the given notifier to react
to them. The notifier will be passed the given configuration to
drive how it behaves; values in the configuration vary based on the
notifier being used.
For instance, a message bus notifier will likely accept in its
configuration the message bus and queue on which to broadcast the event.
@param notifier_type_id: identifies the type of notification to produce
@type notifier_type_id: str
@param notifier_config: used to control how the notifier behaves
@param event_types: list of event types to listen for; valid values
can be found in pulp.server.event.notifiers
@type event_types: list
@return: created event listener instance from the database (i.e. _id
will be populated)
@raise InvalidValue: if the notifier or event type ID aren't found
"""
# Validation
_validate_event_types(event_types)
if not notifiers.is_valid_notifier_type_id(notifier_type_id):
raise InvalidValue(['notifier_type_id'])
# There's no need to check for a conflict; it's possible to use the
# same notifier for the same event type but a different configuration
# Make sure the configuration is at very least empty
if notifier_config is None:
notifier_config = {}
# Create the database entry
el = EventListener(notifier_type_id, notifier_config, event_types)
collection = EventListener.get_collection()
created_id = collection.save(el)
created = collection.find_one(created_id)
return created
def create(self, notifier_type_id, notifier_config, event_types):
"""
Creates a new event listener in the server. The listener will listen
for events of the given types and use the given notifier to react
to them. The notifier will be passed the given configuration to
drive how it behaves; values in the configuration vary based on the
notifier being used.
For instance, a message bus notifier will likely accept in its
configuration the message bus and queue on which to broadcast the event.
@param notifier_type_id: identifies the type of notification to produce
@type notifier_type_id: str
@param notifier_config: used to control how the notifier behaves
@param event_types: list of event types to listen for; valid values
can be found in pulp.server.event.notifiers
@type event_types: list
@return: created event listener instance from the database (i.e. _id
will be populated)
@raise InvalidValue: if the notifier or event type ID aren't found
"""
# Validation
_validate_event_types(event_types)
if not notifiers.is_valid_notifier_type_id(notifier_type_id):
raise InvalidValue(['notifier_type_id'])
# There's no need to check for a conflict; it's possible to use the
# same notifier for the same event type but a different configuration
# Make sure the configuration is at very least empty
if notifier_config is None:
notifier_config = {}
# Create the database entry
el = EventListener(notifier_type_id, notifier_config, event_types)
collection = EventListener.get_collection()
created_id = collection.save(el, safe=True)
created = collection.find_one(created_id)
return created
def test_validator(self):
self.assertTrue(notifiers.is_valid_notifier_type_id(mail.TYPE_ID))
self.assertTrue(notifiers.is_valid_notifier_type_id(http.TYPE_ID))
self.assertFalse(notifiers.is_valid_notifier_type_id(''))
self.assertFalse(notifiers.is_valid_notifier_type_id(123))
self.assertFalse(notifiers.is_valid_notifier_type_id('lhferlihfd'))
