com.jivesoftware.community
Interface JiveContext

public interface JiveContext

A JiveContext is used to access managers that can be used to add, retrieve, modify and delete content in the system as well as control the behaviour of the application. Concrete instances of this class can be retrieved using the JiveApplication.getContext(AuthToken) method.

Method Summary

AbuseManager	getAbuseManager() Returns an abuse manager that can be used for managing abuse reports
com.jivesoftware.community.ActivityManager	getActivityManager() Returns an instance of the activity manager.
AnnouncementManager	getAnnouncementManager() Returns an announcement manager, which is used to create and retrieve announcements.
ArchiveManager	getArchiveManager() Returns an archive manager that can be used to manage archiving for communities.
AttachmentManager	getAttachmentManager() Returns an attachment manager that can be used to manage attachment rules.
AvatarManager	getAvatarManager() Returns a AvatarManager that can be used to find, create, delete, and make avatars active
BanManager	getBanManager() Returns a ban manager that can be used for banning users
BinaryBodyManager	getBinaryBodyManager() Returns a binary document manager that can be used to manage binary body rules.
BlogManager	getBlogManager() Returns a blog manager that can be used to manage blogs
CommentManager	getCommentManager() Returns an instance of the CommentManager.
CommunityManager	getCommunityManager() Returns a community manager which is used to access community wide resources
com.jivesoftware.util.cron.CronTaskManager	getCronTaskManager() Returns a cron task manager that can be used to schedule tasks to run at a specific day/time.
DocumentFieldManager	getDocumentFieldManager() Returns a document field manager that can be used to manage document fields.
DocumentFieldTypeManager	getDocumentFieldTypeManager() Returns a document fieldtype manager that can be used to manage document field types.
DocumentManager	getDocumentManager() Returns a document manager which can be used to retrieve documents.
DocumentTypeManager	getDocumentTypeManager() Returns a document type manager that can be used to manage document types.
DraftManager	getDraftManager() Returns a draft manager that can be used to manage message drafts.
EmailManager	getEmailManager() Returns an email manager that can be used for sending out emails
EmailTokenManager	getEmailTokenManager() Returns an email token manager
ForumManager	getForumManager() Returns a forum manager which can be used to access threads and messages
com.jivesoftware.community.gateway.GatewayManager	getGatewayManager() Returns a gateway manager that can be used for managing gateways
GroupManager	getGroupManager() Returns a group manager that can be used to manage groups.
ImageManager	getImageManager() Returns an image manager that can be used to manage image settings.
IMManager	getIMManager() Returns an instance of the IMManager.
InterceptorManager	getInterceptorManager() Returns an interceptor manager that can be used to manage global interceptors.
<U extends JiveManager> U	getJiveManager(java.lang.Class<?> manager) Returns an instance of a manager if one exists for the specified class.
com.jivesoftware.community.license.ClearspaceLicenseManager	getLicenseManager() Returns an instance of the license manager.
LinkManager	getLinkManager() Returns a WikiLinkManager which can be used to manage links between content in the system.
LocaleManager	getLocaleManager() Returns a locale manager which can be used to get a locale for a particular user/object.
ModerationManager	getModerationManager() Returns a moderation manager that can be used for moderating messages
Permissions	getPermissions(AuthToken authToken) Returns the global permissions that correspond to the passed-in AuthToken.
PermissionsManager	getPermissionsManager() Returns a permissions manager that can be used to set system wide permissions.
PluginManager	getPluginManager() Returns an instance of the plugin which can be used for acquiring plugin instances.
PollManager	getPollManager() Returns a poll manager that can be used to retrieve and manager polls.
PresenceManager	getPresenceManager() Returns a presence manager that can be used to retrieve and manage presences.
PrivateMessageManager	getPrivateMessageManager() Returns a private message manager, which controls private message settings.
ProfileFieldManager	getProfileFieldManager() Returns an instance of the profile field manager.
ProfileManager	getProfileManager() Returns an instance of the profile manager.
ProfileSearchManager	getProfileSearchManager() Returns an instance of the profile search manager.
QuestionManager	getQuestionManager() Returns a QuestionManager, which can be used to manage Questions.
RatingManager	getRatingManager() Returns a RatingManager which can be used to add, retrieve and manage ratings
ReadTracker	getReadTracker() Returns a read tracker that can be used to track which threads and messages a user has read.
RegistrationManager	getRegistrationManager() Returns a validation manager that can be used for validating user accounts
com.jivesoftware.community.RenderCacheManager	getRenderCacheManager() Returns an instance of the render cache manager, used for caching rendered content fields.
RenderManager	getRenderManager() Returns a render manager that can be used to manage system wide render filters and macros.
SearchEngineManager	getSearchEngineManager() Returns a SearchEngineManager which can be used to manager OpenSearch search engines.
SearchManager	getSearchManager() Returns the search manager which can be used to manage the index used by Jive to perform searches.
SearchQueryManager	getSearchQueryManager() Returns the search query manager which can be used to create SearchQuery objects for searching document/messages and blog posts.
StatusLevelManager	getStatusLevelManager() Returns a StatusLevelManager that can be used to check a user status level, find leaders system wide or by community.
com.jivesoftware.community.UserStatusManager	getStatusManager()
StorageManager	getStorageManager() Returns a StorageManager which can be used to manage storage settings for binary objects such as attachments and images.
TagManager	getTagManager() Returns a tag manager that can be used to manage tags.
TagSetManager	getTagSetManager() Returns a TagSetManager that can be used to create and load TagSets.
com.jivesoftware.base.update.UpdateManager	getUpdateManager() Returns an instance of the UpdateManager.
UserManager	getUserManager() Returns a UserManager that can be used to manage users.
WatchManager	getWatchManager() Returns a WatchManager that can be used to manage watches.
WidgetManager	getWidgetManager() Returns an instance of the widget manager.
boolean	isAuthorized(long permissionType) Returns true if the AuthToken used to get an instance of this class has the permission specified.

Method Detail

getAbuseManager

AbuseManager getAbuseManager()

Returns an abuse manager that can be used for managing abuse reports

Returns:

an AbuseManager instance

getAnnouncementManager

AnnouncementManager getAnnouncementManager()

Returns an announcement manager, which is used to create and retrieve announcements.

Returns:

an AnnouncementManager instance

getArchiveManager

ArchiveManager getArchiveManager()

Returns an archive manager that can be used to manage archiving for communities.

Returns:

an ArchiveManager instance

getAttachmentManager

AttachmentManager getAttachmentManager()

Returns an attachment manager that can be used to manage attachment rules.

Returns:

an AttachmentManager instance

getAvatarManager

AvatarManager getAvatarManager()

Returns a AvatarManager that can be used to find, create, delete, and make avatars active

Returns:

an AvatarManager instance

getBanManager

BanManager getBanManager()

Returns a ban manager that can be used for banning users

Returns:

a BanManager instance

getBinaryBodyManager

BinaryBodyManager getBinaryBodyManager()

Returns a binary document manager that can be used to manage binary body rules.

Returns:

a BinaryBodyManager instance

getBlogManager

BlogManager getBlogManager()

Returns a blog manager that can be used to manage blogs

Returns:

a BlogManager instance

getCommunityManager

CommunityManager getCommunityManager()

Returns a community manager which is used to access community wide resources

Returns:

a CommunityManager instance

getCronTaskManager

com.jivesoftware.util.cron.CronTaskManager getCronTaskManager()
                                                              throws UnauthorizedException

Returns a cron task manager that can be used to schedule tasks to run at a specific day/time.

Returns:

a CronTaskManager instance

Throws:

UnauthorizedException - if not an administrator

getDocumentFieldManager

DocumentFieldManager getDocumentFieldManager()

Returns a document field manager that can be used to manage document fields.

Returns:

a DocumentFieldManager instance

getDocumentFieldTypeManager

DocumentFieldTypeManager getDocumentFieldTypeManager()

Returns a document fieldtype manager that can be used to manage document field types.

Returns:

a DocumentFieldTypeManager instance

getDocumentManager

DocumentManager getDocumentManager()

Returns a document manager which can be used to retrieve documents.

Returns:

a DocumentManager instance

getDocumentTypeManager

DocumentTypeManager getDocumentTypeManager()

Returns a document type manager that can be used to manage document types.

Returns:

a DocumentTypeManager instance

getDraftManager

DraftManager getDraftManager()

Returns a draft manager that can be used to manage message drafts.

Returns:

a DraftManager instance

getEmailManager

EmailManager getEmailManager()

Returns an email manager that can be used for sending out emails

Returns:

an EmailManager instance

getEmailTokenManager

EmailTokenManager getEmailTokenManager()
                                       throws UnauthorizedException

Returns an email token manager

Returns:

an EmailTokenManager instance

Throws:

UnauthorizedException - if not a system admin.

getForumManager

ForumManager getForumManager()

Returns a forum manager which can be used to access threads and messages

Returns:

a ForumManager instance

getGatewayManager

com.jivesoftware.community.gateway.GatewayManager getGatewayManager()

Returns a gateway manager that can be used for managing gateways

Returns:

a GatewayManager instance

getGroupManager

GroupManager getGroupManager()

Returns a group manager that can be used to manage groups.

Returns:

a GatewayManager instance

getImageManager

ImageManager getImageManager()

Returns an image manager that can be used to manage image settings.

Returns:

an ImageManager instance

getInterceptorManager

InterceptorManager getInterceptorManager()
                                         throws UnauthorizedException

Returns an interceptor manager that can be used to manage global interceptors.

Returns:

a nInterceptorManager to manage global interceptors.

Throws:

UnauthorizedException - if not a system administrator.

getLocaleManager

LocaleManager getLocaleManager()

Returns a locale manager which can be used to get a locale for a particular user/object.

Returns:

a LocaleManager instance

getModerationManager

ModerationManager getModerationManager()

Returns a moderation manager that can be used for moderating messages

Returns:

a ModerationManager instance

getPermissionsManager

PermissionsManager getPermissionsManager()
                                         throws UnauthorizedException

Returns a permissions manager that can be used to set system wide permissions. Only system admins can perform this function.

Returns:

a PermissionsManager instance

Throws:

UnauthorizedException - if not a system admin.

getPollManager

PollManager getPollManager()

Returns a poll manager that can be used to retrieve and manager polls.

Returns:

a PollManager instance

getPresenceManager

PresenceManager getPresenceManager()

Returns a presence manager that can be used to retrieve and manage presences.

Returns:

a PresenceManager instance

getPrivateMessageManager

PrivateMessageManager getPrivateMessageManager()

Returns a private message manager, which controls private message settings.

Returns:

a PrivateMessageManager instance

getQuestionManager

QuestionManager getQuestionManager()

Returns a QuestionManager, which can be used to manage Questions. This feature is only available in Gold Edition.

Returns:

a QuestionManager instance

getRatingManager

RatingManager getRatingManager()

Returns a RatingManager which can be used to add, retrieve and manage ratings

Returns:

a RatingManager instance

getReadTracker

ReadTracker getReadTracker()

Returns a read tracker that can be used to track which threads and messages a user has read.

Returns:

a ReadTracker instance.

getRegistrationManager

RegistrationManager getRegistrationManager()

Returns a validation manager that can be used for validating user accounts

Returns:

a RegistrationManager instance

getRenderManager

RenderManager getRenderManager()

Returns a render manager that can be used to manage system wide render filters and macros.

Returns:

a RenderManager instance

getSearchManager

SearchManager getSearchManager()
                               throws UnauthorizedException

Returns the search manager which can be used to manage the index used by Jive to perform searches.

Returns:

a SearchManager instance

Throws:

UnauthorizedException - if not a system administator.

getSearchQueryManager

SearchQueryManager getSearchQueryManager()

Returns the search query manager which can be used to create SearchQuery objects for searching document/messages and blog posts.

Returns:

a SearchQueryManager instance

getStatusLevelManager

StatusLevelManager getStatusLevelManager()

Returns a StatusLevelManager that can be used to check a user status level, find leaders system wide or by community. System administrators will also be allowed to manage status levels.

Returns:

a StatusLevelManager instance

getStorageManager

StorageManager getStorageManager()

Returns a StorageManager which can be used to manage storage settings for binary objects such as attachments and images.

Returns:

A StorageManager instance

getSearchEngineManager

SearchEngineManager getSearchEngineManager()

Returns a SearchEngineManager which can be used to manager OpenSearch search engines.

Returns:

A SearchEngineManager instance

getTagManager

TagManager getTagManager()

Returns a tag manager that can be used to manage tags.

Returns:

a TagManager instance

getUserManager

UserManager getUserManager()

Returns a UserManager that can be used to manage users.

Returns:

a UserManager instance

getWatchManager

WatchManager getWatchManager()

Returns a WatchManager that can be used to manage watches.

Returns:

a WatchManager instance

getTagSetManager

TagSetManager getTagSetManager()

Returns a TagSetManager that can be used to create and load TagSets.

Returns:

a TagSetManager that can be used to create and load TagSets.

isAuthorized

boolean isAuthorized(long permissionType)

Returns true if the AuthToken used to get an instance of this class has the permission specified. A list of possible permissions can be found in the Permissions class. Certain methods of this class are restricted to certain permissions as specified in the method comments.

Parameters:

permissionType - a permission type.

Returns:

true if the AuthToken used to get an instance of this class has the permission specified, false otherwise

See Also:

Permissions

getPermissions

Permissions getPermissions(AuthToken authToken)

Returns the global permissions that correspond to the passed-in AuthToken. This method is not generally useful to skin writers. Instead, the isAuthorized(long) method should be used for permission checking.

Parameters:

authToken - the auth token to retrieve the global permissions for

Returns:

the permissions curresponding to the passed-in AuthToken.

getPluginManager

PluginManager getPluginManager()

Returns an instance of the plugin which can be used for acquiring plugin instances.

Returns:

an instance of the plugin which can be used for acquiring plugin instances.

getUpdateManager

com.jivesoftware.base.update.UpdateManager getUpdateManager()

Returns an instance of the UpdateManager.

Returns:

an instance of the UpdateManager.

getIMManager

IMManager getIMManager()

Returns an instance of the IMManager.

Returns:

an instance of the IMManager.

getLicenseManager

com.jivesoftware.community.license.ClearspaceLicenseManager getLicenseManager()

Returns an instance of the license manager.

Returns:

an instance of the license manager.

getLinkManager

LinkManager getLinkManager()

Returns a WikiLinkManager which can be used to manage links between content in the system.

Returns:

a WikiLinkManager which can be used to manage links between content in the system.

getCommentManager

CommentManager getCommentManager()

Returns an instance of the CommentManager.

Returns:

an instance of the CommentManager.

getActivityManager

com.jivesoftware.community.ActivityManager getActivityManager()

Returns an instance of the activity manager. Activity Manager is used for looking at recent activity, etc.

Returns:

an instance of the activity manager.

getRenderCacheManager

com.jivesoftware.community.RenderCacheManager getRenderCacheManager()

Returns an instance of the render cache manager, used for caching rendered content fields.

Returns:

an instance of the render cache manager,

getJiveManager

<U extends JiveManager> U getJiveManager(java.lang.Class<?> manager)

Returns an instance of a manager if one exists for the specified class.

Parameters:

manager - The class for the manager (usually its interface).

Returns:

Instance of a manager class.

getWidgetManager

WidgetManager getWidgetManager()

Returns an instance of the widget manager. Widget Manager is used for loading and rendering widgets

Returns:

an instance of the widget manager.

getProfileManager

ProfileManager getProfileManager()

Returns an instance of the profile manager.

Returns:

an instance of the profile manager.

getProfileFieldManager

ProfileFieldManager getProfileFieldManager()

Returns an instance of the profile field manager.

Returns:

an instance of the profile field manager.

getProfileSearchManager

ProfileSearchManager getProfileSearchManager()

Returns an instance of the profile search manager.

Returns:

an instance of the profile search manager.

getStatusManager

com.jivesoftware.community.UserStatusManager getStatusManager()