jetbrains.buildServer.notification

Interface NotificatorRegistry

public interface NotificatorRegistry

Notificator plugins registry. Each notificator should be registered in this registry. If there are some settings which are required by a notificator to work properly (like email address) they can be represented via editable user properties. A notificator can provide a number of descriptors of these properties (property name and display name) and these properties will appear on the user settings page. Only simple properties (i.e. simple text fields) are supported.

If notificator requires more sophisticated settings from the user it can register either web page extension for the user notificator settings page or it's own web controller (see PlaceId class).

If notificator has system wide settings (like SMTP host) then it can register web page extension for the server configuration page (see WebPlace class).

Author:

Pavel.Sher

Method Summary

Modifier and Type	Method and Description
Notificator	findNotificator(java.lang.String notificatorType)
java.util.Collection<Notificator>	getNotificators()
void	register(Notificator notificator) Registers notificator in the registry.
void	register(Notificator notificator, java.util.List<UserPropertyInfo> userProperties) Registers notificator in the registry.
void	unregister(Notificator notificator) Unregisters notificator.

Method Detail

unregister

void unregister(Notificator notificator)

Unregisters notificator.

Parameters:

notificator - notificator to unregister

register

void register(Notificator notificator)

Registers notificator in the registry.

Parameters:

notificator - notificator to register

register

void register(Notificator notificator,
              java.util.List<UserPropertyInfo> userProperties)

Registers notificator in the registry. This method also allows to register user properties for the notificator. Registered properties descriptors UserPropertyInfo describe properties of the user which can be edited on the user settings page in the Notifications section.

Parameters:

notificator - notificator to register

userProperties - properties to show on the user settings page

getNotificators

java.util.Collection<Notificator> getNotificators()

findNotificator

@Nullable
Notificator findNotificator(java.lang.String notificatorType)