com.adobe.cq.social.notifications.channel

Class AbstractChannel<T extends ChannelExtension>

java.lang.Object

com.adobe.cq.social.notifications.channel.AbstractChannel<T>

All Implemented Interfaces:

Channel

public abstract class AbstractChannel<T extends ChannelExtension>
extends java.lang.Object
implements Channel

Field Summary

Fields inherited from interface com.adobe.cq.social.notifications.channel.Channel

CHANNEL_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
AbstractChannel()

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.lang.String resourceType) Check whether the specified resource type is supported by this channel
java.util.Map<java.lang.String,java.lang.Object>	getConfiguration() Get the channel configuration
void	performAfterDeliver(Notification notification, java.lang.String userId, Session session, java.util.Map<java.lang.String,java.lang.Object> configuration) This method is being called after a channel performs its Channel.deliver(com.adobe.cq.social.notifications.api.Notification, java.lang.String) operation.
void	performBeforeDeliver(Notification notification, java.lang.String userId, Session session, java.util.Map<java.lang.String,java.lang.Object> configuration) This method is being called before a channel performs its Channel.deliver(com.adobe.cq.social.notifications.api.Notification, java.lang.String) operation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.cq.social.notifications.channel.Channel

deliver, getId, getUserDescription, isImmediate

Constructor Detail

AbstractChannel

public AbstractChannel()

Method Detail

accept

public boolean accept(java.lang.String resourceType)

Description copied from interface: Channel

Check whether the specified resource type is supported by this channel

Specified by:

accept in interface Channel

Parameters:

resourceType - String

Returns:

boolean

getConfiguration

public java.util.Map<java.lang.String,java.lang.Object> getConfiguration()

Description copied from interface: Channel

Get the channel configuration

Specified by:

getConfiguration in interface Channel

Returns:

Map of configurations

performBeforeDeliver

public void performBeforeDeliver(Notification notification,
                                 java.lang.String userId,
                                 Session session,
                                 java.util.Map<java.lang.String,java.lang.Object> configuration)
                          throws ChannelException

Description copied from interface: Channel

This method is being called before a channel performs its Channel.deliver(com.adobe.cq.social.notifications.api.Notification, java.lang.String) operation. This is to allow any channel extension to perform any delivery customization.

Specified by:

performBeforeDeliver in interface Channel

Parameters:

notification - the target Notification

userId - the user whom to be notified.

session - the session that is being used to perform the operation.

configuration - the channel configuration.

Throws:

ChannelException - thrown if any one of the operations extensions throws an exception. This aborts the operations.

performAfterDeliver

public void performAfterDeliver(Notification notification,
                                java.lang.String userId,
                                Session session,
                                java.util.Map<java.lang.String,java.lang.Object> configuration)
                         throws ChannelException

Description copied from interface: Channel

This method is being called after a channel performs its Channel.deliver(com.adobe.cq.social.notifications.api.Notification, java.lang.String) operation. This is to allow any channel extension to perform any delivery customization.

Specified by:

performAfterDeliver in interface Channel

Parameters:

notification - the target Notification

userId - the user whom to be notified.

session - the session that is being used to perform the operation.

configuration - the channel configuration.

Throws:

ChannelException - thrown if any one of the operations extensions throws an exception. This aborts the operations.