Jive Forums API (5.5.20.2-oracle) Core Javadocs

Package com.jivesoftware.base

Base APIs and classes for Jive Software products.

See:
          Description

Interface Summary
AdvancedUserManager An advanced user manager which currently has a single method to retrieve a user from a given email address.
AuthToken Proves that a user has successfully logged in.
Group Organizes users into a group for easier permissions management.
GroupManager Manages groups.
IntrospectiveGroup This Group subinterface adds the ability to query what optional capabilities are supported in this Group implementation.
IntrospectiveGroupManager Interface that marks which GroupManager features a particular GroupManager implementation supports.
IntrospectiveUser This User subinterface adds the ability to query what optional capabilities are supported in this User implementation.
IntrospectiveUserManager This UserManager subinterface adds the ability to query what optional capabilities are supported in this UserManager implementation.
JiveEvent JiveEvent is the base interface that all events must implement.
JiveObject An interface for watchable objects.
PermissionsManager Manages permissions for users and groups on a particular resource.
Poll A poll can be attached to any object in the system or can exist at the global level.
PollManager Provides a manager to create, retrieve and delete polls.
Presence A Presence encapsulates information relating to the owning user such as login time, status and last update time.
PresenceManager The presence manager creates presences and keeps track on a global basis who's online.
Roster A roster is a list of users that the user wishes to know if they are online.
User The User interface provides information about and services for users of the system.
UserManager Centralized management of users in the Jive system including creating, retrieving, and deleting User objects.
Watchable A marker interface for objects that can be watched for changes by users.
 

Class Summary
AuthFactory An abstract class that defines a framework for providing authentication services in Jive.
EmailManager Provides ability to send email messages.
EmailMessage Represents an Email message that can be sent using EmailManager
EmailMessage.EmailAddress Represents an email address with a name like Andrew Wright <andrew@jivesoftware.com>
GroupManagerFactory A factory that returns a concrete instance of a group manager.
JiveConstants Contains constant values representing various objects in Jive.
Log Simple wrapper to the JDK logger.
Permissions Represents a set of permissions that an entity has for an object in the system.
PermissionType A class to represent the two modes of permissions - additive and negative.
PollManagerFactory A factory that returns a concrete instance of a poll manager.
UserManagerFactory A factory that returns a concrete instance of a UserManager.
 

Exception Summary
GroupAlreadyExistsException Thrown when attempting to create a group that already exists.
GroupNotFoundException Thrown when unable to find a group.
NotFoundException Thrown when trying to load an object that does not exist, or the object could not be loaded.
PollException A poll exception is thrown by methods in the Poll class.
UnauthorizedException Thrown if a User does not have permission to access a particular method.
UserAlreadyExistsException Thrown when attempting to create a user that already exists.
UserNotFoundException Thrown when User cannot be found.
 

Package com.jivesoftware.base Description

Base APIs and classes for Jive Software products.


Jive Forums Project Page

Copyright © 1999-2006 Jive Software.