org.olat.instantMessaging
Class ClientHelper

java.lang.Object
  org.olat.instantMessaging.ClientHelper

public class ClientHelper
extends java.lang.Object

Helper class needed for rendering the roster and message stuff Iterator free for velocity. Velocity produces warnings when passing objects that return Iterators for looping over collections. Class currenty only needed for roster rendering in navigation bar.

Initial Date: 20.01.2005

Author:

guido

Constructor Summary

ClientHelper(java.lang.String username, Controller controller, VelocityContainer vc, Translator translator)

Method Summary

java.lang.String	buddyCountOnline()
java.lang.String	buddyCountOnlineForGroup(java.lang.String groupname)
static java.lang.String	createAppendixFromGroupName(java.lang.String groupname)
java.util.List	getDistinctRoster() used by velocity
java.lang.String	getJid()
java.lang.String	getOnlineTime()
java.lang.String	getPassword()
java.util.List	getRoster()
java.util.List<java.lang.String>	getRosterGroupEntries(java.lang.String groupname) used by velocity
static java.lang.String	getSendDate(org.jivesoftware.smack.packet.Message msg, java.util.Locale loc)
boolean	getShowOfflineBuddies()
java.lang.String	getStatus()
java.lang.String	getStatusMsg()
java.lang.String	getUserPresence(java.lang.String jid)
boolean	isChatDisabled()
boolean	isConnected()
boolean	isShowGroupsInRoster()
java.lang.String	parseJid(java.lang.String xmppAddressWithRessource)
void	sendPresence(org.jivesoftware.smack.packet.Presence.Type type, java.lang.String status, int priority, org.jivesoftware.smack.packet.Presence.Mode mode)
void	sendPresenceAvailable(org.jivesoftware.smack.packet.Presence.Mode mode) send a presence packet "available" with a certain mode e.g.
void	sendPresenceUnavailable() send a presence packet "unavailable" to all buddies
void	setShowGroupsInRoster(boolean showGroupsInRoster)
void	setShowOfflineBuddies(boolean showOfflineBuddies)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientHelper

public ClientHelper(java.lang.String username,
                    Controller controller,
                    VelocityContainer vc,
                    Translator translator)

Parameters:

username -

locale -

Method Detail

getRoster

public java.util.List getRoster()

Returns:

a List

getDistinctRoster

public java.util.List getDistinctRoster()

used by velocity

Returns:

a list of distinct usernames of the roster

getRosterGroupEntries

public java.util.List<java.lang.String> getRosterGroupEntries(java.lang.String groupname)

used by velocity

Parameters:

groupname -

Returns:

a List

createAppendixFromGroupName

public static java.lang.String createAppendixFromGroupName(java.lang.String groupname)

buddyCountOnlineForGroup

public java.lang.String buddyCountOnlineForGroup(java.lang.String groupname)

Parameters:

groupname -

Returns:

online buddies for a certain group

getUserPresence

public java.lang.String getUserPresence(java.lang.String jid)

Parameters:

jid -

Returns:

the presence

parseJid

public java.lang.String parseJid(java.lang.String xmppAddressWithRessource)

Parameters:

xmppAddressWithRessource -

Returns:

a string like test@testserver.ch

isConnected

public boolean isConnected()

Returns:

true if the user is connected

buddyCountOnline

public java.lang.String buddyCountOnline()

Returns:

a number of the online users for a user

sendPresence

public void sendPresence(org.jivesoftware.smack.packet.Presence.Type type,
                         java.lang.String status,
                         int priority,
                         org.jivesoftware.smack.packet.Presence.Mode mode)

Parameters:

type -

status -

priority -

mode -

getPassword

public java.lang.String getPassword()

Returns:

password

getStatus

public java.lang.String getStatus()

Returns:

status

getStatusMsg

public java.lang.String getStatusMsg()

Returns:

status message

getShowOfflineBuddies

public boolean getShowOfflineBuddies()

Returns:

true if user likes seeing also his offline buddies in the roster

setShowOfflineBuddies

public void setShowOfflineBuddies(boolean showOfflineBuddies)

Parameters:

showOfflineBuddies -

getOnlineTime

public java.lang.String getOnlineTime()

Returns:

online time in minutes

isShowGroupsInRoster

public boolean isShowGroupsInRoster()

Returns:

true if groups should be shown in roster

setShowGroupsInRoster

public void setShowGroupsInRoster(boolean showGroupsInRoster)

Parameters:

showGroupsInRoster -

getJid

public java.lang.String getJid()

Returns:

the users JID like test@testserver.ch

getSendDate

public static java.lang.String getSendDate(org.jivesoftware.smack.packet.Message msg,
                                           java.util.Locale loc)

sendPresenceAvailable

public void sendPresenceAvailable(org.jivesoftware.smack.packet.Presence.Mode mode)

send a presence packet "available" with a certain mode e.g. "away" to all buddies

Parameters:

mode -

sendPresenceUnavailable

public void sendPresenceUnavailable()

send a presence packet "unavailable" to all buddies

isChatDisabled

public boolean isChatDisabled()

Returns:

boolean true if user is allowed to chat and false during teste when chat is disabled