Package org.silverpeas.core.notification.user

Class SimpleUserNotification

java.lang.Object

org.silverpeas.core.notification.user.SimpleUserNotification

All Implemented Interfaces:

UserNotification

public class SimpleUserNotification
extends Object
implements UserNotification

This implementation of UserNotification permits to send a simple user notification, basically a title and a message.

It is also possible to deal with the SilverpeasTemplate API.

This is useful when user notification must be performed into a simple functional context.

This implementation is designed in order to handle the messages into all the handled user languages

Author:

Yohann Chastagnier

Method Summary

Modifier and Type	Method	Description
SimpleUserNotification	andComponentInstanceId(String componentInstanceId)	Sets the instance id of the component from wich the notification is sent.
SimpleUserNotification	andMessage(UnaryOperator<String> message)	Sets the UnaryOperator which provides a message from a language.
SimpleUserNotification	fillTemplate(Pair<String,String> path, BiConsumer<SilverpeasTemplate,String> template)	Sets the BiConsumer which is filling the SilverpeasTemplate data according to given language. SilverpeasTemplate is initialized from given template path represented by a Pair.
static SimpleUserNotification	from(User sender)	Initializes an instance by specifying directly the sender.
static SimpleUserNotification	fromSystem()	Initializes an instance by indicating the system as the sender.
NotificationMetaData	getNotificationMetaData()	Gets the metadata about the notification to send so that all the properties required to send the notification can be set.
void	send()	Sends this notification at the specified addresses declared within the metadata of this notification.
void	send(BuiltInNotifAddress notificationAddress)	Sends this notification to the specified builtin user notification address.
SimpleUserNotification	toEMails(Stream<String> eMails, String language)	Sets the given e-mails as receivers.
SimpleUserNotification	toGroups(Collection<Group> groups)	Sets the users of given groups as receivers.
SimpleUserNotification	toGroups(Stream<Group> groups)	Sets the users of given groups as receivers.
SimpleUserNotification	toGroups(Group... groups)	Sets the users of given groups as receivers.
SimpleUserNotification	toUsers(Collection<User> users)	Sets the given users as receivers.
SimpleUserNotification	toUsers(Stream<User> users)	Sets the given users as receivers.
SimpleUserNotification	toUsers(User... users)	Sets the given users as receivers.
SimpleUserNotification	withExtraMessage(String extraMessage)	Sets an extra message which is not produced against a language.
SimpleUserNotification	withLink(Function<String,Link> link)	Sets the Function which provides a link from a language.
SimpleUserNotification	withTitle(UnaryOperator<String> title)	Sets the UnaryOperator which provides a title from a language.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromSystem

public static SimpleUserNotification fromSystem()

Initializes an instance by indicating the system as the sender.

Returns:

the new instance.

from

public static SimpleUserNotification from(User sender)

Initializes an instance by specifying directly the sender.

Parameters:

sender - the User which represents the sender.

Returns:

itself.

andComponentInstanceId

public SimpleUserNotification andComponentInstanceId(String componentInstanceId)

Sets the instance id of the component from wich the notification is sent.

Parameters:

componentInstanceId - a component instance identifier as string.

Returns:

itself.

withTitle

public SimpleUserNotification withTitle(UnaryOperator<String> title)

Sets the UnaryOperator which provides a title from a language.

Parameters:

title - a UnaryOperator which provides a title by applying a language.

Returns:

itself.

andMessage

public SimpleUserNotification andMessage(UnaryOperator<String> message)

Sets the UnaryOperator which provides a message from a language.

Parameters:

message - a UnaryOperator which provides a message by applying a language.

Returns:

itself.

withExtraMessage

public SimpleUserNotification withExtraMessage(String extraMessage)

Sets an extra message which is not produced against a language.

Parameters:

extraMessage - an extra message as string.

Returns:

itself.

fillTemplate

public SimpleUserNotification fillTemplate(Pair<String,String> path,
                                           BiConsumer<SilverpeasTemplate,String> template)

Sets the BiConsumer which is filling the SilverpeasTemplate data according to given language.
SilverpeasTemplate is initialized from given template path represented by a Pair.

Messages supplied by andMessage(UnaryOperator) are provided to the SilverpeasTemplate by ${message} variable.

Parameters:

path - a Pair defining on the left the path and on the right the name of the aimed template.

template - a Consumer which is filling the SilverpeasTemplate data.

Returns:

itself.

withLink

public SimpleUserNotification withLink(Function<String,Link> link)

Sets the Function which provides a link from a language.

Parameters:

link - a Function which provides a message by applying a language.

Returns:

itself.

toUsers

public SimpleUserNotification toUsers(Collection<User> users)

Sets the given users as receivers.

Parameters:

users - the receivers represented by a list of User.

Returns:

itself.

toUsers

public SimpleUserNotification toUsers(User... users)

Sets the given users as receivers.

Parameters:

users - the receivers represented by an array of User.

Returns:

itself.

toUsers

public SimpleUserNotification toUsers(Stream<User> users)

Sets the given users as receivers.

Parameters:

users - the receivers represented by a stream of User.

Returns:

itself.

toGroups

public SimpleUserNotification toGroups(Collection<Group> groups)

Sets the users of given groups as receivers.

Parameters:

groups - receivers represented by the users contained into the list of Group.

Returns:

itself.

toGroups

public SimpleUserNotification toGroups(Group... groups)

Sets the users of given groups as receivers.

Parameters:

groups - receivers represented by the users contained into the array of Group.

Returns:

itself.

toGroups

public SimpleUserNotification toGroups(Stream<Group> groups)

Sets the users of given groups as receivers.

Parameters:

groups - receivers represented by the users contained into the stream of Group.

Returns:

itself.

toEMails

public SimpleUserNotification toEMails(Stream<String> eMails,
                                       String language)

Sets the given e-mails as receivers.

Parameters:

eMails - a stream of receiver e-mails.

language - the language to use with emails.

Returns:

itself.

getNotificationMetaData

public NotificationMetaData getNotificationMetaData()

Description copied from interface: UserNotification

Gets the metadata about the notification to send so that all the properties required to send the notification can be set.

Specified by:

getNotificationMetaData in interface UserNotification

Returns:

the notification metadata.

send

public void send()

Description copied from interface: UserNotification

Sends this notification at the specified addresses declared within the metadata of this notification.

Specified by:

send in interface UserNotification

send

public void send(BuiltInNotifAddress notificationAddress)

Description copied from interface: UserNotification

Sends this notification to the specified builtin user notification address.

Specified by:

send in interface UserNotification

Parameters:

notificationAddress - the type of the media to vehicle the notification.