com.adobe.cq.social.notifications.channel

Interface Channel

All Known Implementing Classes:

AbstractChannel

public interface Channel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANNEL_DESCRIPTION Service registration property specifying the getUserDescription() return value.

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
void	deliver(Notification notification, java.lang.String userId) Deliver the specified notification
java.util.Map<java.lang.String,java.lang.Object>	getConfiguration() Get the channel configuration
java.lang.String	getId() The id of this channel
java.lang.String	getUserDescription() Get the description of this channel
boolean	isImmediate() Check whether this channel to be executed immediately or not
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 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 deliver(com.adobe.cq.social.notifications.api.Notification, java.lang.String) operation.

Field Detail

CHANNEL_DESCRIPTION

static final java.lang.String CHANNEL_DESCRIPTION

Service registration property specifying the getUserDescription() return value.

Channel service SHOULD be registered with this property. The value of the property is a string that describes the functionality of the channel.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

The id of this channel

Returns:

STring

isImmediate

boolean isImmediate()

Check whether this channel to be executed immediately or not

Returns:

boolean

getUserDescription

java.lang.String getUserDescription()

Get the description of this channel

Returns:

String

deliver

void deliver(Notification notification,
             java.lang.String userId)
      throws ChannelException

Deliver the specified notification

Parameters:

notification - Notification

userId - the user whom to be notified.

Throws:

ChannelException - Channel Exception

performBeforeDeliver

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

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

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

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

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

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.

accept

boolean accept(java.lang.String resourceType)

Check whether the specified resource type is supported by this channel

Parameters:

resourceType - String

Returns:

boolean

getConfiguration

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

Get the channel configuration

Returns:

Map of configurations