com.day.cq.wcm.notification

Class NotificationUtil

java.lang.Object

com.day.cq.wcm.notification.NotificationUtil

public abstract class NotificationUtil
extends java.lang.Object

Utility class for notifications.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_CHANNEL_NAME The configuration property holding the channel type.
static java.lang.String	PROPERTY_CHANNEL_TYPE The configuration property holding the channel type.
static java.lang.String	PROPERTY_SUBSCRIPTION_TYPE The configuration property holding the subscription type.

Constructor Summary

Constructors

Constructor and Description
NotificationUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getChannelName(java.util.Map subscriptionConfig) Return the channel name for the config.
static java.lang.String	getChannelType(java.util.Map channelConfig) Return the channel type for the config.
static Node	getNotificationNode(Authorizable authorizable) Deprecated. Use NotificationUtil#getNotificationNode(String, javax.jcr.Session) instead
static Node	getNotificationNode(Authorizable authorizable, Session s) Deprecated. Use NotificationUtil#getNotificationNode(String, javax.jcr.Session) instead
static Node	getNotificationNode(java.lang.String authorizablePath, Session s) Return the node for the settings of the notification module of an authorizable.
static java.lang.String	getSubscriptionType(java.util.Map subscriptionConfig) Return the subscription type for the config.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_CHANNEL_TYPE

public static final java.lang.String PROPERTY_CHANNEL_TYPE

The configuration property holding the channel type.

See Also:

Constant Field Values

PROPERTY_CHANNEL_NAME

public static final java.lang.String PROPERTY_CHANNEL_NAME

The configuration property holding the channel type.

See Also:

Constant Field Values

PROPERTY_SUBSCRIPTION_TYPE

public static final java.lang.String PROPERTY_SUBSCRIPTION_TYPE

The configuration property holding the subscription type.

See Also:

Constant Field Values

Constructor Detail

NotificationUtil

public NotificationUtil()

Method Detail

getChannelType

public static java.lang.String getChannelType(java.util.Map channelConfig)

Return the channel type for the config.

Parameters:

channelConfig - The channel configuration.

Returns:

The channel type or null

getChannelName

public static java.lang.String getChannelName(java.util.Map subscriptionConfig)

Return the channel name for the config.

Parameters:

subscriptionConfig - The subscription configuration.

Returns:

The channel name or null

getSubscriptionType

public static java.lang.String getSubscriptionType(java.util.Map subscriptionConfig)

Return the subscription type for the config.

Parameters:

subscriptionConfig - The subscription configuration.

Returns:

The subscription type or null

getNotificationNode

public static Node getNotificationNode(Authorizable authorizable)
                                throws RepositoryException

Deprecated. Use NotificationUtil#getNotificationNode(String, javax.jcr.Session) instead

Return the node for the settings of the notification module of an authorizable.

Parameters:

authorizable - The authorizable.

Returns:

The node or null if not possible to get the node

Throws:

RepositoryException - Upon encountering a repository error getting the notification node.

Since:

5.4

getNotificationNode

public static Node getNotificationNode(Authorizable authorizable,
                                       Session s)
                                throws RepositoryException

Deprecated. Use NotificationUtil#getNotificationNode(String, javax.jcr.Session) instead

Return the node for the settings of the notification module of an authorizable.

Parameters:

authorizable - The authorizable.

s - The session to get the node

Returns:

The node

Throws:

RepositoryException - Upon encountering a repository error getting the notification node.

Since:

5.4

getNotificationNode

public static Node getNotificationNode(java.lang.String authorizablePath,
                                       Session s)
                                throws RepositoryException

Return the node for the settings of the notification module of an authorizable.

Parameters:

authorizablePath - The path of the authorizable.

s - The session to get the node

Returns:

The node

Throws:

RepositoryException - Upon encountering a repository error getting the notification node.

Since:

6.2