com.ibm.tivoli.imi.drivers.xmpp

Class IMSessionXMPPImpl

java.lang.Object

com.ibm.tivoli.imi.drivers.xmpp.IMSessionXMPPImpl

All Implemented Interfaces:

IMSession

public class IMSessionXMPPImpl
extends java.lang.Object
implements IMSession

Author:

fabiosc@br.ibm.com - Fabio Silva Carvalho 04/09/2008

Constructor Summary

Constructors

Constructor and Description
IMSessionXMPPImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	changeUserStatus(IMUser.IMUserStatus imUserStatus) Changes the user status related to the connection established with IM server
void	close() Closes the connection established with IM server.
void	configure(java.util.Properties properties) Configures the session using the properties specified.
IMMessageHandler	createMessageHandler(IMUser partner) Creates a new message handler allowing objects to do operations like sending new messages, closing the conversation or verifying if the conversation is still opened
IMResolveHandler	createResolveHandler(boolean onlyUnique, boolean exhaustiveLookup) Creates and returns a resolve object
IMUserStatusHandler	createUserStatusHandler() Creates a new user status handler allowing listener objects to be registered to be notified when some user changes his/her IM status
long	getConnectionTimeout() Returns the connection timeout
long	getDefaultConnectionTimeout() Returns the default connection timeout
long	getDefaultResolveTimeout() Returns the default resolve timeout
IMUser	getIMUser() Returns the IMUser object related to the user account used to open this IM chat session.
long	getResolveTimeout() Returns the resolve timeout
java.lang.String	getServerHostName()
int	getServerPort()
java.lang.String	getServiceName()
java.lang.String	getSessionName() Returns the session name
java.lang.String	getUserId()
java.lang.String	getUserPassword()
boolean	isOpened()
void	open() Connects to the IM server using the information set using IMSession.configure(Properties) method.
void	registerIMSingleListener(IMSingleListener listener) Registers a new listener for handling incoming messages.
void	removeIMSingleListener(IMSingleListener listener) Remove the specified IMSingleListener
IMUser	resolve(java.lang.String userDisplayName) Resolves the user identified by userDisplayName parameter.
IMResolveEvent	resolve(java.lang.String userDisplayName, boolean onlyUnique, boolean exhaustiveLookup) Resolves the user identified by userDisplayName parameter.
void	setConnectionTimeout(long timeout) Defines the timeout used by method IMSession.open().
void	setResolveTimeout(long timeout) Defines the timeout used by method IMSession.resolve(String, boolean, boolean).

Methods inherited from class java.lang.Object

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

Constructor Detail

IMSessionXMPPImpl

public IMSessionXMPPImpl()

Method Detail

configure

public void configure(java.util.Properties properties)
               throws IMException

Description copied from interface: IMSession

Configures the session using the properties specified. A unique session name is automatically created and set to this session. The method IMDriver.validateProperties(Properties) can be used to make sure that the properties are valid

Specified by:

configure in interface IMSession

Throws:

IMException - if the properties are invalid or if the session could not be created

getServerHostName

public java.lang.String getServerHostName()

Specified by:

getServerHostName in interface IMSession

getServerPort

public int getServerPort()

getServiceName

public java.lang.String getServiceName()

getSessionName

public java.lang.String getSessionName()

Description copied from interface: IMSession

Returns the session name

Specified by:

getSessionName in interface IMSession

Returns:

the session name or null if it is not opened yet

getUserId

public java.lang.String getUserId()

Specified by:

getUserId in interface IMSession

getUserPassword

public java.lang.String getUserPassword()

Specified by:

getUserPassword in interface IMSession

getIMUser

public IMUser getIMUser()

Description copied from interface: IMSession

Returns the IMUser object related to the user account used to open this IM chat session. If the session is not opened yet this method will return null

Specified by:

getIMUser in interface IMSession

Returns:

the IMUser object related to the user account used to open this IM chat session or null if the session is not opened yet

open

public void open()
          throws IMException

Description copied from interface: IMSession

Connects to the IM server using the information set using IMSession.configure(Properties) method. This method uses a connection timeout set by IMSession.setConnectionTimeout(long), and not returns until the timeout is over or the connection opens. So, this method is blocking (bolcks the current thread). A not blockiing method to open a session will be available soon.

Specified by:

open in interface IMSession

Throws:

IMException - if it is not possible to open the session (invalid user or password, for example), or if the connection timeout has finished

changeUserStatus

public void changeUserStatus(IMUser.IMUserStatus imUserStatus)
                      throws IMException

Description copied from interface: IMSession

Changes the user status related to the connection established with IM server

Specified by:

changeUserStatus in interface IMSession

Throws:

IMException - if the IM session is not opened

close

public void close()
           throws IMException

Description copied from interface: IMSession

Closes the connection established with IM server. It doesn't do nothing it the session is not opened

Specified by:

close in interface IMSession

Throws:

IMException - if some error occurs during the closing operation

isOpened

public boolean isOpened()

Specified by:

isOpened in interface IMSession

createResolveHandler

public IMResolveHandler createResolveHandler(boolean onlyUnique,
                                    boolean exhaustiveLookup)
                                      throws IMException

Description copied from interface: IMSession

Creates and returns a resolve object

Specified by:

createResolveHandler in interface IMSession

Parameters:

onlyUnique - This option determines whether the created resolver object should resolve successfully only if the provided name is matched exactly in the IM directory

exhaustiveLookup - This option determines whether the created resolver object should perform an exhaustive lookup through all directories or stop in the first directory where a match is found

Returns:

Throws:

IMException - if this session is not opened yet, or if the partner can not be resolved

createUserStatusHandler

public IMUserStatusHandler createUserStatusHandler()
                                            throws IMException

Description copied from interface: IMSession

Creates a new user status handler allowing listener objects to be registered to be notified when some user changes his/her IM status

Specified by:

createUserStatusHandler in interface IMSession

Returns:

a new user status handler

Throws:

IMException - if this session is not opened yet

createMessageHandler

public IMMessageHandler createMessageHandler(IMUser partner)
                                      throws IMException

Description copied from interface: IMSession

Creates a new message handler allowing objects to do operations like sending new messages, closing the conversation or verifying if the conversation is still opened

Specified by:

createMessageHandler in interface IMSession

Returns:

a new user status handler

Throws:

IMException - if this session is not opened yet

resolve

public IMResolveEvent resolve(java.lang.String userDisplayName,
                     boolean onlyUnique,
                     boolean exhaustiveLookup)
                       throws IMException

Description copied from interface: IMSession

Resolves the user identified by userDisplayName parameter. This method is blocking, what means that the thread that call this method will be blocked until the resolve operation is finished. It happens because this function is done remotely. Use a IMResolveHandler object and a IMResolveListener class if you don't want to block your thread to use this function.

Specified by:

resolve in interface IMSession

onlyUnique - This option determines if it should resolve successfully only if the provided name is matched exactly in the IM directory

exhaustiveLookup - This option determines if it should perform an exhaustive lookup through all directories or stop in the first directory where a match is found

Returns:

this object contains all information needed to get the STUser object or to know the reason that it could not be generated

Throws:

IMException - if the session is not opened, or if the resolve operation is not concluded in X milliseconds. X can be set using IMSession.setResolveTimeout(long) method

See Also:

IMSession.createResolveHandler(boolean, boolean)

resolve

public IMUser resolve(java.lang.String userDisplayName)
               throws IMException,
                      IMException

Description copied from interface: IMSession

Resolves the user identified by userDisplayName parameter. This method is blocking, what means that the thread that call this method will be blocked until the resolve operation is finished. It happens because this function is done remotely. Use a IMResolveHandler object and a IMResolveListener class if you don't want to block your thread to use this function. This method returns a user resolve only if the display name is exactly equal to the existent in server

Specified by:

resolve in interface IMSession

Returns:

the user resolved or null if could not be found

Throws:

IMException - if the session is not opened, or if the resolve operation is not concluded in X milliseconds. X can be set using IMSession.setResolveTimeout(long) method

See Also:

IMSession.createResolveHandler(boolean, boolean)

getDefaultConnectionTimeout

public long getDefaultConnectionTimeout()

Description copied from interface: IMSession

Returns the default connection timeout

Specified by:

getDefaultConnectionTimeout in interface IMSession

Returns:

the default connection timeout

setConnectionTimeout

public void setConnectionTimeout(long timeout)

Description copied from interface: IMSession

Defines the timeout used by method IMSession.open(). If a connection timeout is not set, the default value will be used. The default connection timeout value can be got using the IMSession.getDefaultConnectionTimeout() method

Specified by:

setConnectionTimeout in interface IMSession

getConnectionTimeout

public long getConnectionTimeout()

Description copied from interface: IMSession

Returns the connection timeout

Specified by:

getConnectionTimeout in interface IMSession

Returns:

the connection timeout

getDefaultResolveTimeout

public long getDefaultResolveTimeout()

Description copied from interface: IMSession

Returns the default resolve timeout

Specified by:

getDefaultResolveTimeout in interface IMSession

Returns:

the default resolve timeout

setResolveTimeout

public void setResolveTimeout(long timeout)

Description copied from interface: IMSession

Defines the timeout used by method IMSession.resolve(String, boolean, boolean). If a resolve timeout is not set, the default value will be used. The default resolve timeout value can be got using the IMSession.getDefaultResolveTimeout() method

Specified by:

setResolveTimeout in interface IMSession

getResolveTimeout

public long getResolveTimeout()

Description copied from interface: IMSession

Returns the resolve timeout

Specified by:

getResolveTimeout in interface IMSession

Returns:

the resolve timeout

registerIMSingleListener

public void registerIMSingleListener(IMSingleListener listener)
                              throws IMException

Description copied from interface: IMSession

Registers a new listener for handling incoming messages.

Specified by:

registerIMSingleListener in interface IMSession

Throws:

IMException

removeIMSingleListener

public void removeIMSingleListener(IMSingleListener listener)
                            throws IMException

Description copied from interface: IMSession

Remove the specified IMSingleListener

Specified by:

removeIMSingleListener in interface IMSession

Throws:

IMException