com.adobe.cq.social.commons.ugclimiter.api

Interface UGCLimiterService

@ProviderType
public interface UGCLimiterService

A service to throttle UGC creation.

Method Summary

Modifier and Type	Method and Description
long	getUgcDuration() Gets the ugc duration for ugc rate limit in minutes.
int	getUgcLimit() Gets the ugc rate limit.
java.lang.String[]	getUgcLimitedToList() Gets the to List to which a user can send mail to request for exception in ugc limit.
boolean	mayCreateUGC(ResourceResolver resolver, java.lang.String userId) Check if a user can create any more UGC if UGC Limits is enabled for the user.
boolean	mayCreateUGC(ResourceResolver resolver, User user) Check if a user can create any more UGC if UGC Limits is enabled for the user.

Method Detail

mayCreateUGC

boolean mayCreateUGC(ResourceResolver resolver,
                     User user)

Check if a user can create any more UGC if UGC Limits is enabled for the user.

Parameters:

resolver - used for reading previously stored ugc limits data

user - the user to check

Returns:

true if user can create more UGC or has no UGC limits.

mayCreateUGC

boolean mayCreateUGC(ResourceResolver resolver,
                     java.lang.String userId)

Check if a user can create any more UGC if UGC Limits is enabled for the user.

Parameters:

resolver - used for reading previously stored ugc limits data

userId - the userid to check

Returns:

true if user can create more UGC or has no UGC limits.

getUgcLimit

int getUgcLimit()

Gets the ugc rate limit.

Returns:

the ugc limit

getUgcDuration

long getUgcDuration()

Gets the ugc duration for ugc rate limit in minutes. 0 means the time never expires.

Returns:

the ugc duration

getUgcLimitedToList

java.lang.String[] getUgcLimitedToList()

Gets the to List to which a user can send mail to request for exception in ugc limit.

Returns:

the array containing one or more moderator mails