LimitController (JCMS API)

java.lang.Object
- com.jalios.jcms.LimitController

All Implemented Interfaces:

JcmsConstants, JaliosConstants
```
public class LimitController
extends java.lang.Object
implements JcmsConstants
```
Since:

jcms-5.5.0

Version:

$Revision: 98042 $

Author:

Olivier Dedieu

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`MAX_COLLABORATIVE_SPACES`
`protected static int`	`MAX_DBFILEDOCUMENT`
`protected static int`	`MAX_DBMEMBERS`
`protected static int`	`MAX_GUESTS`
`protected static int`	`MAX_LANGUAGES`
`protected static int`	`MAX_MEMBERS`
`protected static int`	`MAX_WORKSPACES`
`static java.lang.String`	`REVISION`
`protected static java.lang.String`	`THRESHOLD_ALERT_FREQ_PROP`
`protected static java.lang.String`	`THRESHOLD_ALERT_NAME`
`protected static java.lang.String`	`THRESHOLD_GUEST_PROP`
`protected static java.lang.String`	`THRESHOLD_PREFIX_PROP`

Fields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors
Constructor and Description

LimitController()

Constructors
Constructor and Description
`LimitController()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkAlertThreshold(Data data)`
`ControllerStatus`	`checkAllLimits()` Checks all the limits for all the controlled resources.
`ControllerStatus`	`checkCollaborativeSpaceLimit(boolean add)` Checks collaborative spaces limit.
`ControllerStatus`	`checkDBFileDocumentLimit(boolean add)` Checks DBFileDocument limit.
`ControllerStatus`	`checkDBMemberLimit(boolean add)` Checks DBMember limit.
`ControllerStatus`	`checkGuestLimit(boolean add)` Checks Guest limit.
`ControllerStatus`	`checkLanguageLimit(boolean add)` Checks language limit.
`ControllerStatus`	`checkMemberLimit(boolean add)` Checks member limit.
`ControllerStatus`	`checkWorkspaceLimit(boolean add)` Checks workspace limit.
`int`	`getActiveDBMemberCount()` Returns the count of active DBMember (account and enabled).
`int`	`getActiveMemberCount()` Returns the count of active DBMember (account and enabled).
`int`	`getCollaborativeSpaceLimit()`
`int`	`getDBFileDocumentLimit()`
`int`	`getDBMemberLimit()`
`int`	`getGuestCount()` Returns the count of active Guest.
`int`	`getGuestLimit()`
`int`	`getLanguageLimit()`
`int`	`getLimit(java.lang.Class<? extends Data> clazz)` Returns the limit for a given Data class.
`int`	`getMemberLimit()`
`int`	`getWorkspaceLimit()`
`void`	`init()`
`void`	`registerLimitControllerListener()` This method should only be called by Channel.
`void`	`resetSendingMap()`
`void`	`setGuestLimit(int limit)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REVISION
```
public static final java.lang.String REVISION
```
    See Also:
    
    Constant Field Values
  - MAX_WORKSPACES
```
protected static final int MAX_WORKSPACES
```
    See Also:
    
    Constant Field Values
  - MAX_COLLABORATIVE_SPACES
```
protected static final int MAX_COLLABORATIVE_SPACES
```
    See Also:
    
    Constant Field Values
  - MAX_MEMBERS
```
protected static final int MAX_MEMBERS
```
    See Also:
    
    Constant Field Values
  - MAX_DBMEMBERS
```
protected static final int MAX_DBMEMBERS
```
    See Also:
    
    Constant Field Values
  - MAX_GUESTS
```
protected static final int MAX_GUESTS
```
    See Also:
    
    Constant Field Values
  - MAX_DBFILEDOCUMENT
```
protected static final int MAX_DBFILEDOCUMENT
```
    See Also:
    
    Constant Field Values
  - MAX_LANGUAGES
```
protected static final int MAX_LANGUAGES
```
    See Also:
    
    Constant Field Values
  - THRESHOLD_ALERT_NAME
```
protected static final java.lang.String THRESHOLD_ALERT_NAME
```
    See Also:
    
    Constant Field Values
  - THRESHOLD_PREFIX_PROP
```
protected static final java.lang.String THRESHOLD_PREFIX_PROP
```
    See Also:
    
    Constant Field Values
  - THRESHOLD_GUEST_PROP
```
protected static final java.lang.String THRESHOLD_GUEST_PROP
```
    See Also:
    
    Constant Field Values
  - THRESHOLD_ALERT_FREQ_PROP
```
protected static final java.lang.String THRESHOLD_ALERT_FREQ_PROP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LimitController
```
public LimitController()
```
- Method Detail
  - init
```
public void init()
```
  - registerLimitControllerListener
```
public void registerLimitControllerListener()
```
    This method should only be called by Channel.
    
    Since:
    
    jcms-8.0.0
  - checkAllLimits
```
public ControllerStatus checkAllLimits()
```
    Checks all the limits for all the controlled resources.
    
    Returns:
    
    a ControllerStatus
    
    Since:
    
    jcms-5.5.0
  - checkWorkspaceLimit
```
public ControllerStatus checkWorkspaceLimit(boolean add)
```
    Checks workspace limit.
    
    Parameters:
    
    add - if true check for a new workspace.
    
    Returns:
    
    a ControllerStatus
    
    Since:
    
    jcms-5.5.0
  - checkCollaborativeSpaceLimit
```
public ControllerStatus checkCollaborativeSpaceLimit(boolean add)
```
    Checks collaborative spaces limit.
    
    Parameters:
    
    add - if true check for a new collaborative space.
    
    Returns:
    
    a ControllerStatus
    
    Since:
    
    jcms-5.5.0
  - checkMemberLimit
```
public ControllerStatus checkMemberLimit(boolean add)
```
    Checks member limit.
    
    Parameters:
    
    add - if true check for a new member.
    
    Returns:
    
    a ControllerStatus
    
    Since:
    
    jcms-5.5.0
  - getActiveMemberCount
```
public int getActiveMemberCount()
```
    Returns the count of active DBMember (account and enabled).
    
    Returns:
    
    the count of active DBMember (account and enabled).
    
    Since:
    
    jcms-8.0.0
  - checkDBMemberLimit
```
public ControllerStatus checkDBMemberLimit(boolean add)
```
    Checks DBMember limit.
    
    Parameters:
    
    add - if true check for a new DBMember.
    
    Returns:
    
    a ControllerStatus
    
    Since:
    
    jcms-5.5.0
  - getActiveDBMemberCount
```
public int getActiveDBMemberCount()
```
    Returns the count of active DBMember (account and enabled).
    
    Returns:
    
    the count of active DBMember (account and enabled).
    
    Since:
    
    jcms-8.0.0
  - checkGuestLimit
```
public ControllerStatus checkGuestLimit(boolean add)
```
    Checks Guest limit.
    
    Parameters:
    
    add - if true check for a new Guest.
    
    Returns:
    
    a ControllerStatus
    
    Since:
    
    jcms-10.0.0
  - getGuestCount
```
public int getGuestCount()
```
    Returns the count of active Guest.
    
    Returns:
    
    the count of active Guest.
    
    Since:
    
    jcms-10.0.0
  - checkDBFileDocumentLimit
```
public ControllerStatus checkDBFileDocumentLimit(boolean add)
```
    Checks DBFileDocument limit.
    
    Parameters:
    
    add - if true check for a new DBFileDocument.
    
    Returns:
    
    a ControllerStatus
    
    Since:
    
    jcms-5.5.0
  - checkLanguageLimit
```
public ControllerStatus checkLanguageLimit(boolean add)
```
    Checks language limit.
    
    Parameters:
    
    add - if true check for a new language.
    
    Returns:
    
    a ControllerStatus
    
    Since:
    
    jcms-5.5.0
  - getLanguageLimit
```
public int getLanguageLimit()
```
  - getLimit
```
public int getLimit(java.lang.Class<? extends Data> clazz)
```
    Returns the limit for a given Data class.
    
    Parameters:
    
    clazz - the Data class.
    
    Returns:
    
    the limit for a given Data class.
    
    Since:
    
    jcms-8.0.0
  - getMemberLimit
```
public int getMemberLimit()
```
  - getDBMemberLimit
```
public int getDBMemberLimit()
```
  - getGuestLimit
```
public int getGuestLimit()
```
  - setGuestLimit
```
public void setGuestLimit(int limit)
```
  - getDBFileDocumentLimit
```
public int getDBFileDocumentLimit()
```
  - getWorkspaceLimit
```
public int getWorkspaceLimit()
```
  - getCollaborativeSpaceLimit
```
public int getCollaborativeSpaceLimit()
```
  - checkAlertThreshold
```
public void checkAlertThreshold(Data data)
```
  - resetSendingMap
```
public void resetSendingMap()
```

Class LimitController

Field Summary

Fields inherited from interface com.jalios.jcms.JcmsConstants

Fields inherited from interface com.jalios.util.JaliosConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REVISION

MAX_WORKSPACES

MAX_COLLABORATIVE_SPACES

MAX_MEMBERS

MAX_DBMEMBERS

MAX_GUESTS

MAX_DBFILEDOCUMENT

MAX_LANGUAGES

THRESHOLD_ALERT_NAME

THRESHOLD_PREFIX_PROP

THRESHOLD_GUEST_PROP

THRESHOLD_ALERT_FREQ_PROP

Constructor Detail

LimitController

Method Detail

init

registerLimitControllerListener

checkAllLimits

checkWorkspaceLimit

checkCollaborativeSpaceLimit

checkMemberLimit

getActiveMemberCount

checkDBMemberLimit

getActiveDBMemberCount

checkGuestLimit

getGuestCount

checkDBFileDocumentLimit

checkLanguageLimit

getLanguageLimit

getLimit

getMemberLimit

getDBMemberLimit

getGuestLimit

setGuestLimit

getDBFileDocumentLimit

getWorkspaceLimit

getCollaborativeSpaceLimit

checkAlertThreshold

resetSendingMap