org.olat.instantMessaging
Class InstantMessagingModule

java.lang.Object
  org.olat.instantMessaging.InstantMessagingModule

All Implemented Interfaces:

OLATModule, UserDataDeletable

public class InstantMessagingModule
extends java.lang.Object
implements OLATModule, UserDataDeletable

Description:
Configuration class that is instantiated by the framework if configured in olat_config.xml. For configuration issues see olat.properties and run the ant task config-all to affect the changes. Do not edit the olat_config.xml manually! All classes from the instant messaging package obtain there configuration values by calling the methods of this class.

Initial Date: 14.10.2004

Author:

Guido Schnider

Constructor Summary

InstantMessagingModule()
call superclass constructor

Method Summary

void	deleteUserData(Identity identity, java.lang.String newDeletedUserName) Delete user data for certain user
void	destroy() Caled during Servlet.destroy()
static InstantMessaging	getAdapter()
static int	getCHAT_POLLTIME()
static int	getIDLE_POLLTIME()
void	init(com.anthonyeden.lib.config.Configuration configuration) Called by ConfigurationManager during statrup.
static boolean	isEnabled()
static boolean	isSyncLearningGroups()
static void	setCHAT_POLLTIME(int chat_polltime)
static void	setIDLE_POLLTIME(int idle_polltime)

Methods inherited from class java.lang.Object

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

Constructor Detail

InstantMessagingModule

public InstantMessagingModule()

call superclass constructor

Method Detail

init

public void init(com.anthonyeden.lib.config.Configuration configuration)

Description copied from interface: OLATModule

Called by ConfigurationManager during statrup. Module is called in the order it is registered in olat_config.xml. On any critical errors, throw StartupException. Any other errors, just throw Exceptions. OLATContext will already be initialized at this stage.

Specified by:

init in interface OLATModule

See Also:

OLATModule.init(com.anthonyeden.lib.config.Configuration)

destroy

public void destroy()

Description copied from interface: OLATModule

Caled during Servlet.destroy()

Specified by:

destroy in interface OLATModule

See Also:

OLATModule.destroy()

getAdapter

public static InstantMessaging getAdapter()

Returns:

the adapter instance

isEnabled

public static boolean isEnabled()

Returns:

Returns the enabled.

deleteUserData

public void deleteUserData(Identity identity,
                           java.lang.String newDeletedUserName)

Description copied from interface: UserDataDeletable

Delete user data for certain user

Specified by:

deleteUserData in interface UserDataDeletable

Parameters:

identity - Data for this identity will be deleted

See Also:

org.olat.user.UserDataDeletable#deleteUserData(org.olat.core.id.Identity)

getIDLE_POLLTIME

public static int getIDLE_POLLTIME()

Returns:

Returns the iDLE_POLLTIME.

setIDLE_POLLTIME

public static void setIDLE_POLLTIME(int idle_polltime)

Parameters:

idle_polltime - The iDLE_POLLTIME to set.

getCHAT_POLLTIME

public static int getCHAT_POLLTIME()

Returns:

Returns the cHAT_POLLTIME.

setCHAT_POLLTIME

public static void setCHAT_POLLTIME(int chat_polltime)

Parameters:

chat_polltime - The cHAT_POLLTIME to set.

isSyncLearningGroups

public static boolean isSyncLearningGroups()