Package org.ametys.plugins.pagesubscription.dao

Class AbstractSubscriptionsDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.pagesubscription.dao.AbstractSubscriptionsDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

Direct Known Subclasses:

ForceTagSubscriptionsDAO, PageSubscriptionsDAO, TagSubscriptionsDAO

public abstract class AbstractSubscriptionsDAO
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Abstract DAO for subscriptions

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	the Avalon context
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected AmetysObjectResolver	_resolver	The ametys object resolver

Constructor Summary

Constructors

Constructor	Description
AbstractSubscriptionsDAO()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
Map<String,Object>	editSubscription(String subscriptionId, String frequency, List<String> broadcastChannels)	Edit the current user subscription with the given id
Map<String,Object>	editSubscription(String subscriptionId, String frequency, SubscriptionType.FrequencyTiming forcedTiming, List<String> broadcastChannels, boolean checkCurrentUser)	Edit the subscription with the given id
Map<String,Object>	getSubscription(String subscriptionId)	Get the current user subscription from the given id
Map<String,Object>	getSubscription(String subscriptionId, boolean checkCurrentUser)	Get the subscription from the given id
void	service(ServiceManager smanager)
boolean	unsubscribe(String subscriptionId)	Remove the current user subscription with the given id
boolean	unsubscribe(String subscriptionId, boolean checkCurrentUser)	Remove the subscription with the given id

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_context

protected Context _context

the Avalon context

Constructor Details

AbstractSubscriptionsDAO

public AbstractSubscriptionsDAO()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getSubscription

public Map<String,Object> getSubscription(String subscriptionId)

Get the current user subscription from the given id

Parameters:

subscriptionId - the subscription id

Returns:

the subscription as JSON

getSubscription

public Map<String,Object> getSubscription(String subscriptionId,
 boolean checkCurrentUser)

Get the subscription from the given id

Parameters:

subscriptionId - the subscription id

checkCurrentUser - true to check if the subscription belong to the current user

Returns:

the subscription as JSON

editSubscription

public Map<String,Object> editSubscription(String subscriptionId,
 String frequency,
 List<String> broadcastChannels)

Edit the current user subscription with the given id

Parameters:

subscriptionId - the subscription id

frequency - the frequency

broadcastChannels - the broadcast channels

Returns:

the subscription as JSON

editSubscription

public Map<String,Object> editSubscription(String subscriptionId,
 String frequency,
 SubscriptionType.FrequencyTiming forcedTiming,
 List<String> broadcastChannels,
 boolean checkCurrentUser)

Edit the subscription with the given id

Parameters:

subscriptionId - the subscription id

frequency - the frequency

forcedTiming - the force frequency timing. Can be null if not forced

broadcastChannels - the broadcast channels

checkCurrentUser - true to check if the subscription belong to the current user

Returns:

a Map with success status and the subscription as JSON

unsubscribe

public boolean unsubscribe(String subscriptionId)
                    throws Exception

Remove the current user subscription with the given id

Parameters:

subscriptionId - the subscription id

Returns:

true if successfully subscribe, false otherwise

Throws:

Exception - if an error occurred

unsubscribe

public boolean unsubscribe(String subscriptionId,
 boolean checkCurrentUser)
                    throws Exception

Remove the subscription with the given id

Parameters:

subscriptionId - the subscription id

checkCurrentUser - true to check if the subscription belong to the current user

Returns:

true if successfully subscribe, false otherwise

Throws:

Exception - if an error occurred