Package org.cyclos.impl.utils.notifications

Class NotificationHandlerImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseNetworkedHandlerImpl

org.cyclos.impl.utils.notifications.NotificationHandlerImpl

All Implemented Interfaces:

NotificationHandler, NotificationHandlerImplementor

@Component
public class NotificationHandlerImpl
extends BaseNetworkedHandlerImpl
implements NotificationHandlerImplementor

Service implementation for notifications

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.impl.utils.notifications.NotificationHandler

ATTR_ENTITY, ATTR_TYPE, ATTR_USER

Constructor Summary

Constructors

Constructor	Description
NotificationHandlerImpl()

Method Summary

Modifier and Type	Method	Description
AdminNotificationsHandler	admin()	It returns a handler to allow to notify administrators.
void	initialize()
protected boolean	networkCheck(User admin, NetworkedEntity entity)
void	notify(BasicUser user, UserNotificationType type, NotificationURL url, SimpleEntity entity, User relatedUser, Object... arguments)	Notify a user about an event on Cyclos and allow to add an optional URL associated to it.
UserNotificationsHandlerAccessor	user(BasicUser user)	It returns an accessor used to get a handler to allow notify the specified user.
String	withDescription(Transaction transaction)	Returns either a text such as " with description [description]" or empty if the transaction has no description

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationHandlerImpl

public NotificationHandlerImpl()

Method Detail

admin

public AdminNotificationsHandler admin()

Description copied from interface: NotificationHandler

It returns a handler to allow to notify administrators.

Specified by:

admin in interface NotificationHandler

initialize

@PostConstruct
public void initialize()

notify

public void notify(BasicUser user,
                   UserNotificationType type,
                   NotificationURL url,
                   SimpleEntity entity,
                   User relatedUser,
                   Object... arguments)

Description copied from interface: NotificationHandlerImplementor

Notify a user about an event on Cyclos and allow to add an optional URL associated to it. First, it is checked whether the given user can actually receive the notification. If not, do nothing. If the user receives the notification, a Notification is persisted, and will be later processed to send e-mail and / or SMS.

Specified by:

notify in interface NotificationHandlerImplementor

user

public UserNotificationsHandlerAccessor user(BasicUser user)

Description copied from interface: NotificationHandler

It returns an accessor used to get a handler to allow notify the specified user.

Specified by:

user in interface NotificationHandler

withDescription

public String withDescription(Transaction transaction)

Description copied from interface: NotificationHandler

Returns either a text such as " with description [description]" or empty if the transaction has no description

Specified by:

withDescription in interface NotificationHandler

networkCheck

protected boolean networkCheck(User admin,
                               NetworkedEntity entity)