InstantMessengerAdaptor Class Reference

Inherits com::webobjects::appserver::WOAdaptor, and er::imadaptor::IMessageListener.

Collaboration diagram for InstantMessengerAdaptor:

[legend]

List of all members.

Classes
class	ConversationExpirationRunnable
Public Member Functions
InstantMessengerConnection	_addInstantMessenger (String screenName, String password)
InstantMessengerConnection	_defaultInstantMessengerConnection ()
InstantMessengerConnection	_instantMessengerConnectionNamed (String screenName)
void	_removeInstantMessengerConnection (InstantMessengerConnection connection)
InstantMessengerConnection	addInstantMessenger (String screenName, String password)
IInstantMessenger	defaultInstantMessenger ()
boolean	dispatchesRequestsConcurrently ()
IInstantMessenger	instantMessenger ()
	InstantMessengerAdaptor (String name, NSDictionary parameters)
IInstantMessenger	instantMessengerForScreenName (String screenName)
synchronized void	messageReceived (IInstantMessenger instantMessenger, String buddyName, String rawMessage)
void	registerForEvents ()
void	removeInstantMessenger (String screenName)
void	sendMessage (String screenName, String buddyName, String message, boolean block) throws MessageException
void	sessionDidCreate (NSNotification notification)
InstantMessengerConnection	setDefaultInstantMessenger (String screenName, String password)
void	unregisterForEvents ()
Static Public Member Functions
static String	buddyName (WORequest request)
static Conversation	conversation (WORequest request)
static InstantMessengerAdaptor	instantMessengerAdaptor ()
static boolean	isIMRequest (WORequest request)
static boolean	isIMRequest (WOContext context)
static String	message (WORequest request)
static String	rawMessage (WORequest request)
Static Public Attributes
static final String	AUTO_LOGIN_KEY = "IMAutoLogin"
static final String	BUDDY_NAME_KEY = "BuddyName"
static final String	CENTRALIZE_SCREEN_NAME_KEY = "IMCentralizeScreenName"
static final String	CONVERSATION_ACTION_NAME_KEY = "IMConversationActionName"
static final String	CONVERSATION_KEY = "IMConversation"
static final String	CONVERSATION_TIMEOUT_KEY = "IMTimeout"
static final String	IM_ACTION_URL_KEY = "IMActionURL"
static final String	IM_FACTORY_KEY = "IMFactory"
static final String	IS_IM_KEY = "IsIM"
static Logger	log = Logger.getLogger(InstantMessengerAdaptor.class)
static final String	MESSAGE_KEY = "Message"
static final String	PASSWORD_KEY = "IMPassword"
static final String	RAW_MESSAGE_KEY = "RawMessage"
static final String	SCREEN_NAME_KEY = "IMScreenName"
static final String	WATCHER_ENABLED_KEY = "IMWatcherEnabled"
static final String	WATCHER_IM_FACTORY_KEY = "IMWatcherFactory"
static final String	WATCHER_PASSWORD_KEY = "IMWatcherPassword"
static final String	WATCHER_SCREEN_NAME_KEY = "IMWatcherScreenName"
Protected Member Functions
IInstantMessengerFactory	getFactory (String key)
void	removeExpiredConversations ()
Static Package Functions
	[static initializer]
Private Attributes
WOApplication	_application
boolean	_autoLogin
String	_centralizeScreenName
String	_conversationActionName
long	_conversationTimeout
String	_defaultScreenName
IInstantMessengerFactory	_factory
Map< String, InstantMessengerConnection >	_instantMessengers
boolean	_running

---

Constructor & Destructor Documentation

InstantMessengerAdaptor	(	String	name,
		NSDictionary	parameters
	)

---

Member Function Documentation

[static initializer]

(

)

[static, package]

InstantMessengerConnection _addInstantMessenger	(	String	screenName,
		String	password
	)

InstantMessengerConnection _defaultInstantMessengerConnection

(

)

InstantMessengerConnection _instantMessengerConnectionNamed

(

String

screenName

)

void _removeInstantMessengerConnection

(

InstantMessengerConnection

connection

)

InstantMessengerConnection addInstantMessenger	(	String	screenName,
		String	password
	)

static String buddyName

(

WORequest

request

)

[static]

static Conversation conversation

(

WORequest

request

)

[static]

IInstantMessenger defaultInstantMessenger

(

)

boolean dispatchesRequestsConcurrently

(

)

IInstantMessengerFactory getFactory

(

String

key

)

[protected]

IInstantMessenger instantMessenger

(

)

Deprecated:

use defaultInstantMessenger() instead

static InstantMessengerAdaptor instantMessengerAdaptor

(

)

[static]

IInstantMessenger instantMessengerForScreenName

(

String

screenName

)

static boolean isIMRequest

(

WORequest

request

)

[static]

static boolean isIMRequest

(

WOContext

context

)

[static]

static String message

(

WORequest

request

)

[static]

synchronized void messageReceived	(	IInstantMessenger	instantMessenger,
		String	buddyName,
		String	rawMessage
	)

Implements IMessageListener.

static String rawMessage

(

WORequest

request

)

[static]

void registerForEvents

(

)

void removeExpiredConversations

(

)

[protected]

void removeInstantMessenger

(

String

screenName

)

void sendMessage	(	String	screenName,
		String	buddyName,
		String	message,
		boolean	block
	)			throws MessageException

void sessionDidCreate

(

NSNotification

notification

)

InstantMessengerConnection setDefaultInstantMessenger	(	String	screenName,
		String	password
	)

void unregisterForEvents

(

)

---

Member Data Documentation

WOApplication _application [private]

boolean _autoLogin [private]

String _centralizeScreenName [private]

String _conversationActionName [private]

long _conversationTimeout [private]

String _defaultScreenName [private]

IInstantMessengerFactory _factory [private]

Map<String, InstantMessengerConnection> _instantMessengers [private]

boolean _running [private]

final String AUTO_LOGIN_KEY = "IMAutoLogin" [static]

final String BUDDY_NAME_KEY = "BuddyName" [static]

final String CENTRALIZE_SCREEN_NAME_KEY = "IMCentralizeScreenName" [static]

final String CONVERSATION_ACTION_NAME_KEY = "IMConversationActionName" [static]

final String CONVERSATION_KEY = "IMConversation" [static]

final String CONVERSATION_TIMEOUT_KEY = "IMTimeout" [static]

final String IM_ACTION_URL_KEY = "IMActionURL" [static]

final String IM_FACTORY_KEY = "IMFactory" [static]

final String IS_IM_KEY = "IsIM" [static]

Logger log = Logger.getLogger(InstantMessengerAdaptor.class) [static]

final String MESSAGE_KEY = "Message" [static]

final String PASSWORD_KEY = "IMPassword" [static]

final String RAW_MESSAGE_KEY = "RawMessage" [static]

final String SCREEN_NAME_KEY = "IMScreenName" [static]

final String WATCHER_ENABLED_KEY = "IMWatcherEnabled" [static]

final String WATCHER_IM_FACTORY_KEY = "IMWatcherFactory" [static]

final String WATCHER_PASSWORD_KEY = "IMWatcherPassword" [static]

final String WATCHER_SCREEN_NAME_KEY = "IMWatcherScreenName" [static]

---

The documentation for this class was generated from the following file:

• /opt/source/Wonder/Frameworks/WOAdaptors/ERIMAdaptor/Sources/er/imadaptor/InstantMessengerAdaptor.java