com.jivesoftware.base
Class PresenceManagerProxy

java.lang.Object
  com.jivesoftware.base.PresenceManagerProxy

All Implemented Interfaces:

PresenceManager

public class PresenceManagerProxy
extends java.lang.Object
implements PresenceManager

Protection proxy for the PresenceManager class.

Field Summary

Fields inherited from interface com.jivesoftware.base.PresenceManager

SORT_ONLINE_TIME, SORT_USERNAME

Constructor Summary

PresenceManagerProxy(PresenceManager manager, AuthToken authToken, Permissions permissions)

Method Summary

Presence	createPresence(User user, java.lang.String uid, java.lang.String IPAddress) Create a presence for a user.
int	getOnlineGuestCount() Returns the number of guests who are currently online.
int	getOnlineUserCount() Returns the number of users who are currently online.
int	getOnlineUserCount(Group group) Returns the number of users in the group who are currently online.
java.util.Iterator	getOnlineUsers() Returns an iterator of users who are currently online.
java.util.Iterator	getOnlineUsers(boolean ascending, int sortField) Returns an iterator of users sorted in the manner requested who are currently online.
java.util.Iterator	getOnlineUsers(boolean ascending, int sortField, int numResults) Returns an iterator of users who are currently online matching the criteria given.
java.util.Iterator	getOnlineUsers(boolean ascending, int sortField, int start, int numResults) Returns an iterator of users who are currently online matching the criteria given.
java.util.Iterator	getOnlineUsers(Group group) Returns an iterator of users in the group who are currently online.
java.util.Iterator	getOnlineUsers(Group group, boolean ascending, int sortField) Returns an iterator of users sorted in the manner requested who are currently online.
java.util.Iterator	getOnlineUsers(Group group, boolean ascending, int sortField, int numResults) Returns an iterator of users who are currently online matching the criteria given.
Presence	getPresence(User user) Returns the presence for the user, or null if the user isn't online.
Roster	getRoster(User user) Returns the user's roster.
boolean	isOnline(User user) Returns whether the user is currently online or not.
boolean	isPresencesEnabled() Returns whether presences are enabled on a global basis or not.
void	setOffline(Presence presence) Sets a presence to be offline which causes the presence to be removed from the system.
void	setPresencesEnabled(boolean enabled) Sets whether presences are enabled on a global basis or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

PresenceManagerProxy

public PresenceManagerProxy(PresenceManager manager,
                            AuthToken authToken,
                            Permissions permissions)

Method Detail

isPresencesEnabled

public boolean isPresencesEnabled()

Description copied from interface: PresenceManager

Returns whether presences are enabled on a global basis or not.

Specified by:

isPresencesEnabled in interface PresenceManager

Returns:

whether presences are enabled on a global basis or not.

setPresencesEnabled

public void setPresencesEnabled(boolean enabled)
                         throws UnauthorizedException

Description copied from interface: PresenceManager

Sets whether presences are enabled on a global basis or not.

Specified by:

setPresencesEnabled in interface PresenceManager

Parameters:

enabled - true if presences should be enabled, false otherwise.

Throws:

UnauthorizedException - if not a system administrator.

getOnlineUserCount

public int getOnlineUserCount()

Description copied from interface: PresenceManager

Returns the number of users who are currently online. Online users with a presence status set to invisible will not be included.

Specified by:

getOnlineUserCount in interface PresenceManager

Returns:

the number of online users.

getOnlineUserCount

public int getOnlineUserCount(Group group)

Description copied from interface: PresenceManager

Returns the number of users in the group who are currently online. Online users with a presence status set to invisible will not be included.

Specified by:

getOnlineUserCount in interface PresenceManager

Parameters:

group - the group to return the online user count.

Returns:

the number of online users in the group.

getOnlineGuestCount

public int getOnlineGuestCount()

Description copied from interface: PresenceManager

Returns the number of guests who are currently online. Guests with a presence status other that online or idle will not be included.

Specified by:

getOnlineGuestCount in interface PresenceManager

Returns:

the number of online users.

isOnline

public boolean isOnline(User user)

Description copied from interface: PresenceManager

Returns whether the user is currently online or not. If the user's status is set to Presence.STATUS_INVISIBLE, the user will never show up as online.

Specified by:

isOnline in interface PresenceManager

Parameters:

user - the user to check to see if they're online.

getOnlineUsers

public java.util.Iterator getOnlineUsers()

Description copied from interface: PresenceManager

Returns an iterator of users who are currently online. Online users with a presence status other that online or idle will not be included.

Specified by:

getOnlineUsers in interface PresenceManager

Returns:

an iterator of online users.

getOnlineUsers

public java.util.Iterator getOnlineUsers(Group group)

Description copied from interface: PresenceManager

Returns an iterator of users in the group who are currently online. Online users with a presence statas set to invisible will not be included.

Specified by:

getOnlineUsers in interface PresenceManager

Parameters:

group - the group to return the online users.

Returns:

an iterator of online users in the group.

getOnlineUsers

public java.util.Iterator getOnlineUsers(boolean ascending,
                                         int sortField)

Description copied from interface: PresenceManager

Returns an iterator of users sorted in the manner requested who are currently online. Online users with a presence status other that online or idle will not be included.

Specified by:

getOnlineUsers in interface PresenceManager

Parameters:

ascending - sort ascending if true, descending if false.

sortField - a valid sort field from the PresenceManager interface.

Returns:

an iterator of online users.

getOnlineUsers

public java.util.Iterator getOnlineUsers(Group group,
                                         boolean ascending,
                                         int sortField)

Description copied from interface: PresenceManager

Returns an iterator of users sorted in the manner requested who are currently online. Online users with a presence status other that online or idle will not be included.

Specified by:

getOnlineUsers in interface PresenceManager

Parameters:

group - the group to return the online users.

ascending - sort ascending if true, descending if false.

sortField - a valid sort field from the PresenceManager interface.

Returns:

an iterator of online users in the group.

getOnlineUsers

public java.util.Iterator getOnlineUsers(boolean ascending,
                                         int sortField,
                                         int numResults)

Description copied from interface: PresenceManager

Returns an iterator of users who are currently online matching the criteria given. Online users with a presence status other than online or idle will not be included.

Specified by:

getOnlineUsers in interface PresenceManager

Parameters:

ascending - sort ascending if true, descending if false.

sortField - a valid sort field from the PresenceManager interface.

numResults - - the number of results to return.

Returns:

an iterator of online users matching the given criteria.

getOnlineUsers

public java.util.Iterator getOnlineUsers(Group group,
                                         boolean ascending,
                                         int sortField,
                                         int numResults)

Description copied from interface: PresenceManager

Returns an iterator of users who are currently online matching the criteria given. Online users with a presence status other than online or idle will not be included.

Specified by:

getOnlineUsers in interface PresenceManager

ascending - sort ascending if true, descending if false.

sortField - a valid sort field from the PresenceManager interface.

numResults - - the number of results to return.

Returns:

an iterator of online users matching the given criteria.

getOnlineUsers

public java.util.Iterator getOnlineUsers(boolean ascending,
                                         int sortField,
                                         int start,
                                         int numResults)

Description copied from interface: PresenceManager

Returns an iterator of users who are currently online matching the criteria given. Online users with a presence status other than online or idle will not be included.

Specified by:

getOnlineUsers in interface PresenceManager

Parameters:

ascending - sort ascending if true, descending if false.

sortField - a valid sort field from the PresenceManager interface.

start - the index into the sorted set of users to start iterating from.

numResults - - the number of results to return.

Returns:

an iterator of online users matching the given criteria.

getPresence

public Presence getPresence(User user)

Description copied from interface: PresenceManager

Returns the presence for the user, or null if the user isn't online.

Specified by:

getPresence in interface PresenceManager

Parameters:

user - the user to return the presence for.

Returns:

the presence for the user, or null if the user isn't online.

getRoster

public Roster getRoster(User user)
                 throws UnauthorizedException

Description copied from interface: PresenceManager

Returns the user's roster. A roster is a list of users that the user wishes to know if they are online. Rosters are similar to buddy groups in popular IM clients.

Specified by:

getRoster in interface PresenceManager

Parameters:

user - the user to return the roster for.

Returns:

the user's roster.

Throws:

UnauthorizedException - if not the user or an administrator.

createPresence

public Presence createPresence(User user,
                               java.lang.String uid,
                               java.lang.String IPAddress)
                        throws UnauthorizedException

Description copied from interface: PresenceManager

Create a presence for a user. Creating a presence will automatically set the user to be online.

The uid should be unique within the application instance. A good source of a uid is the servlet session id.

Specified by:

createPresence in interface PresenceManager

Parameters:

user - the user to create a presence for.

uid - a unique string.

IPAddress - the IP address of the user.

Returns:

the presence for the user.

Throws:

UnauthorizedException - if not the user.

setOffline

public void setOffline(Presence presence)
                throws UnauthorizedException

Description copied from interface: PresenceManager

Sets a presence to be offline which causes the presence to be removed from the system.

Specified by:

setOffline in interface PresenceManager

Parameters:

presence - to presence to set to be offline.

Throws:

UnauthorizedException - if not the user.