org.exoplatform.services.xmpp.connection.impl
Class XMPPSessionImpl

java.lang.Object
  org.exoplatform.services.xmpp.connection.impl.XMPPSessionImpl

All Implemented Interfaces:

XMPPSession

public class XMPPSessionImpl
extends java.lang.Object
implements XMPPSession

Created by The eXo Platform SAS.

Version:

$Id: $

Author:

Vitaly Parfonov

Constructor Summary

protected

XMPPSessionImpl(java.lang.String username, java.lang.String password, UserInfoService organization, org.exoplatform.ws.frameworks.cometd.transport.ContinuationServiceDelegate delegate, HistoryImpl history, java.util.ResourceBundle rb)

Method Summary

void	addBuddy(java.lang.String username, java.lang.String nickname, java.lang.String group) Add new buddy to roster.
boolean	addTransport(Transport transport, java.lang.String remoteUser, java.lang.String remotePassword, boolean autoLogin) Check is Transport supported and add it to List of available transports.
void	askForSubscription(java.lang.String username, java.lang.String nickname) Ask for subscription to user with given name.
void	banUser(java.lang.String room, java.lang.String nickname, java.lang.String reason)
void	changeAvailabilityStatusInRoom(java.lang.String room, java.lang.String status, java.lang.String mode) Change status in the room (e.g Extend Away).
void	changeNickname(java.lang.String room, java.lang.String nickname) Change nickname in the room.
void	changeSubject(java.lang.String room, java.lang.String newSubject) Change subject of the room.
boolean	cleanBuddiesList() Clean buddies list.
void	close() Close current connection and send notification to buddies.
org.jivesoftware.smackx.muc.MultiUserChat	configRoom(java.lang.String room, ConfigRoomBean cr) Configure the group chat.
void	createGroup(java.lang.String grop)
FormBean	createRoom(java.lang.String room, java.lang.String nickname) Create new group chat.
void	declineRoom(java.lang.String room, java.lang.String inviter, java.lang.String reason) Decline the invitation to the room.
java.lang.Boolean	destroyRoom(java.lang.String room, java.lang.String reason, java.lang.String altRoom) Destroy the group chat.
java.util.List<HistoricalMessage>	getAllHistory(java.lang.String usernameto, java.lang.String usernamefrom, boolean isGroupChat) Get history.
java.util.List<org.jivesoftware.smack.packet.Presence>	getBuddiesPresense() Get list of Presence for all buddies for current user.
org.jivesoftware.smack.RosterEntry	getBuddy(java.lang.String name) Return the roster entry by the name of user.
FormBean	getConfigFormRoom(java.lang.String room) get configuration form for group chat.
org.jivesoftware.smack.XMPPConnection	getConnection()
org.jivesoftware.smackx.filetransfer.FileTransferRequest	getFileTransferRequest(java.lang.String uuid)
java.util.List<HistoricalMessage>	getHistoryBetweenDate(java.lang.String usernameto, java.lang.String usernamefrom, boolean isGroupChat, java.util.Date dateFrom, java.util.Date dateTo) Get history between two date.
java.util.List<HistoricalMessage>	getHistoryFromDateToNow(java.lang.String usernameto, java.lang.String usernamefrom, boolean isGroupChat, java.util.Date dateFrom) Get history between the date and current time.
java.util.List<Interlocutor>	getInterlocutors(java.lang.String username) Get all interlocutors of user.
java.util.List<java.lang.String>	getJoinedRooms() Get already joined rooms.
org.jivesoftware.smackx.muc.MultiUserChat	getMultiUserChat(java.lang.String room)
MultiUserChatManager	getMultiUserChatManager()
java.util.List<HistoricalMessage>	getNotRecieveMessages() Get all not received message.
org.jivesoftware.smackx.muc.RoomInfo	getRoomInfo(java.lang.String room)
FullRoomInfoBean	getRoomInfoBean(java.lang.String room) Get full information about room.
InitInfoBean	getRooms(java.lang.Integer from, java.lang.Integer to, java.lang.String sort)
org.jivesoftware.smackx.Form	getSearchForm(java.lang.String searchService) Get form for searching users.
java.util.List<java.lang.String>	getSearchServices()
org.exoplatform.services.jcr.ext.common.SessionProvider	getSessionProvider()
UserInfo	getUserInfo(java.lang.String userID) Get the information about user by user id.
java.lang.String	getUsername() Get the username.
java.lang.Boolean	inviteToRoom(java.lang.String room, java.lang.String invitee, java.lang.String reason) Invite to the room.
java.lang.Boolean	isJoin(java.lang.String room) True if join in the room.
boolean	isPasswordRequired(java.lang.String room)
void	joinRoom(java.lang.String room, java.lang.String nickname, java.lang.String password) Join to the group chat.
void	kickUser(java.lang.String room, java.lang.String nickname, java.lang.String reason)
java.lang.Boolean	leaveRoom(java.lang.String room) Leave the room.
void	manageAffiliation(java.lang.String room, java.lang.String nickname, java.lang.String affiliation, java.lang.String command)
void	manageRole(java.lang.String room, java.lang.String nickname, java.lang.String role, java.lang.String command) The manage role of user in the room.
void	messageReceive(java.lang.String messageId) Set that message is received.
void	rejectFile(java.lang.String uuid)
void	removeAllTransport() Remove all transport subscribed for current user.
boolean	removeBuddy(java.lang.String name) Remove remote user from contacts list.
boolean	removeTransport(Transport transport) Remove transport from available list.
org.jivesoftware.smackx.ReportedData	searchUser(java.lang.String search, boolean byUsername, boolean byName, boolean byEmail, java.lang.String searchService)
void	sendErrorMessage(java.lang.String msg, java.lang.String sender)
void	sendFile(java.lang.String requestor, java.lang.String path, java.lang.String description, boolean isRoom)
void	sendMessage(org.jivesoftware.smack.packet.Message message) Send message.
void	sendMessageToMUC(java.lang.String room, java.lang.String body) Send message to the room.
void	sendPresence(org.jivesoftware.smack.packet.Presence presence) Change presence for current user.
void	subscribeUser(java.lang.String user) Subscribe remote user and send message to that user.
void	subscribeUser(java.lang.String toUser, java.lang.String serviceName) Subscribe remote user and send message to that user.
void	unsubscribeUser(java.lang.String user) Unsubscribe remote user and send message to that user.
void	unsubscribeUser(java.lang.String toUser, java.lang.String serviceName) Unsubscribe remote user and send message to that user.
void	updateBuddy(java.lang.String username, java.lang.String nickname, java.lang.String group) Update the buddy in roster.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMPPSessionImpl

protected XMPPSessionImpl(java.lang.String username,
                          java.lang.String password,
                          UserInfoService organization,
                          org.exoplatform.ws.frameworks.cometd.transport.ContinuationServiceDelegate delegate,
                          HistoryImpl history,
                          java.util.ResourceBundle rb)
                   throws org.jivesoftware.smack.XMPPException

Throws:

org.jivesoftware.smack.XMPPException

Method Detail

addTransport

public boolean addTransport(Transport transport,
                            java.lang.String remoteUser,
                            java.lang.String remotePassword,
                            boolean autoLogin)

Check is Transport supported and add it to List of available transports. User can use remote accounts on other IM servers. (ICQ, Yahoo, etc).

Specified by:

addTransport in interface XMPPSession

Parameters:

transport - the name of transport

remoteUser - the username

remotePassword - the password

autoLogin - not working now

Returns:

true if successfully

addBuddy

public void addBuddy(java.lang.String username,
                     java.lang.String nickname,
                     java.lang.String group)
              throws org.jivesoftware.smack.XMPPException

Add new buddy to roster.

Specified by:

addBuddy in interface XMPPSession

Parameters:

username - the username

nickname - the nickname

group - the group

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

askForSubscription

public void askForSubscription(java.lang.String username,
                               java.lang.String nickname)

Ask for subscription to user with given name.

Specified by:

askForSubscription in interface XMPPSession

Parameters:

username - the username

nickname - the nickname

getBuddy

public org.jivesoftware.smack.RosterEntry getBuddy(java.lang.String name)

Return the roster entry by the name of user.

Specified by:

getBuddy in interface XMPPSession

Parameters:

name - the username

Returns:

the rosterEntry

updateBuddy

public void updateBuddy(java.lang.String username,
                        java.lang.String nickname,
                        java.lang.String group)
                 throws org.jivesoftware.smack.XMPPException

Update the buddy in roster.

Specified by:

updateBuddy in interface XMPPSession

Parameters:

username - the useranme

nickname - the nickanme

group - the group

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

createGroup

public void createGroup(java.lang.String grop)

Parameters:

grop - the group name

cleanBuddiesList

public boolean cleanBuddiesList()
                         throws org.jivesoftware.smack.XMPPException

Clean buddies list.

Specified by:

cleanBuddiesList in interface XMPPSession

Returns:

true if all user removed from the list of user false otherwise.

Throws:

org.jivesoftware.smack.XMPPException

close

public void close()

Close current connection and send notification to buddies.

Specified by:

close in interface XMPPSession

getAllHistory

public java.util.List<HistoricalMessage> getAllHistory(java.lang.String usernameto,
                                                       java.lang.String usernamefrom,
                                                       boolean isGroupChat)

Get history.

Specified by:

getAllHistory in interface XMPPSession

Parameters:

usernameto - the username who recive message

usernamefrom - the username who send message

isGroupChat - is the group chat

Returns:

list of historyMessages

getBuddiesPresense

public java.util.List<org.jivesoftware.smack.packet.Presence> getBuddiesPresense()

Get list of Presence for all buddies for current user.

Specified by:

getBuddiesPresense in interface XMPPSession

Returns:

list of Presence.

getConnection

public org.jivesoftware.smack.XMPPConnection getConnection()

Specified by:

getConnection in interface XMPPSession

Returns:

XMPPConnection.

getHistoryBetweenDate

public java.util.List<HistoricalMessage> getHistoryBetweenDate(java.lang.String usernameto,
                                                               java.lang.String usernamefrom,
                                                               boolean isGroupChat,
                                                               java.util.Date dateFrom,
                                                               java.util.Date dateTo)

Get history between two date.

Specified by:

getHistoryBetweenDate in interface XMPPSession

Parameters:

usernameto - the username who recive message

usernamefrom - the username who send message

isGroupChat - is the group chat

dateFrom - the begin

dateTo - the end

Returns:

list of historyMessages

getHistoryFromDateToNow

public java.util.List<HistoricalMessage> getHistoryFromDateToNow(java.lang.String usernameto,
                                                                 java.lang.String usernamefrom,
                                                                 boolean isGroupChat,
                                                                 java.util.Date dateFrom)

Get history between the date and current time.

Specified by:

getHistoryFromDateToNow in interface XMPPSession

Parameters:

usernameto - the username who recive message

usernamefrom - the username who send message

isGroupChat - is the group chat

dateFrom - the begin

Returns:

list of historyMessages

getNotRecieveMessages

public java.util.List<HistoricalMessage> getNotRecieveMessages()

Get all not received message.

Specified by:

getNotRecieveMessages in interface XMPPSession

Returns:

list of not received message

getInterlocutors

public java.util.List<Interlocutor> getInterlocutors(java.lang.String username)

Get all interlocutors of user.

Specified by:

getInterlocutors in interface XMPPSession

Parameters:

username - thr username

Returns:

list

getMultiUserChatManager

public MultiUserChatManager getMultiUserChatManager()

Returns:

the MultiuserChat

isJoin

public java.lang.Boolean isJoin(java.lang.String room)
                         throws org.jivesoftware.smack.XMPPException

True if join in the room.

Specified by:

isJoin in interface XMPPSession

Parameters:

room - the room name

Returns:

true if joined to the room

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

getSearchForm

public org.jivesoftware.smackx.Form getSearchForm(java.lang.String searchService)
                                           throws org.jivesoftware.smack.XMPPException

Get form for searching users.

Specified by:

getSearchForm in interface XMPPSession

Parameters:

searchService - the name of searchService

Returns:

the Form.

Throws:

org.jivesoftware.smack.XMPPException

getSearchServices

public java.util.List<java.lang.String> getSearchServices()

Specified by:

getSearchServices in interface XMPPSession

Returns:

the List of search services names.

getUserInfo

public UserInfo getUserInfo(java.lang.String userID)

Get the information about user by user id.

Specified by:

getUserInfo in interface XMPPSession

Parameters:

userID - the user id

Returns:

the userInfo

getUsername

public java.lang.String getUsername()

Get the username.

Specified by:

getUsername in interface XMPPSession

Returns:

the username;

removeAllTransport

public void removeAllTransport()
                        throws org.jivesoftware.smack.XMPPException

Remove all transport subscribed for current user.

Specified by:

removeAllTransport in interface XMPPSession

Throws:

org.jivesoftware.smack.XMPPException

removeBuddy

public boolean removeBuddy(java.lang.String name)
                    throws org.jivesoftware.smack.XMPPException

Remove remote user from contacts list.

Specified by:

removeBuddy in interface XMPPSession

Parameters:

name - the full ID of remote user.

Returns:

true if user removed successful false otherwise.

Throws:

org.jivesoftware.smack.XMPPException

removeTransport

public boolean removeTransport(Transport transport)
                        throws org.jivesoftware.smack.XMPPException

Remove transport from available list. For user it minds close connection with remote users which were available through this transport (ICQ, Yahoo, etc).

Specified by:

removeTransport in interface XMPPSession

Parameters:

transport - the Transport.

Returns:

true if successfully

Throws:

org.jivesoftware.smack.XMPPException

searchUser

public org.jivesoftware.smackx.ReportedData searchUser(java.lang.String search,
                                                       boolean byUsername,
                                                       boolean byName,
                                                       boolean byEmail,
                                                       java.lang.String searchService)
                                                throws org.jivesoftware.smack.XMPPException

Specified by:

searchUser in interface XMPPSession

Parameters:

search - the search string.

byUsername - search in useranme

byName - search in name

byEmail - search in mail

searchService - the SearchService name.

Returns:

the list of users which match for searching string.

Throws:

org.jivesoftware.smack.XMPPException

sendMessage

public void sendMessage(org.jivesoftware.smack.packet.Message message)

Send message.

Specified by:

sendMessage in interface XMPPSession

Parameters:

message - the message

sendMessageToMUC

public void sendMessageToMUC(java.lang.String room,
                             java.lang.String body)
                      throws org.jivesoftware.smack.XMPPException

Send message to the room.

Specified by:

sendMessageToMUC in interface XMPPSession

Parameters:

room - the room name

body - the body of message

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

sendPresence

public void sendPresence(org.jivesoftware.smack.packet.Presence presence)

Change presence for current user.

Specified by:

sendPresence in interface XMPPSession

Parameters:

presence - the new Presence.

subscribeUser

public void subscribeUser(java.lang.String user)

Subscribe remote user and send message to that user.

Specified by:

subscribeUser in interface XMPPSession

Parameters:

user - the full ID of remote user.

subscribeUser

public void subscribeUser(java.lang.String toUser,
                          java.lang.String serviceName)

Subscribe remote user and send message to that user.

Specified by:

subscribeUser in interface XMPPSession

Parameters:

toUser - the remote user.

serviceName - the service name.

unsubscribeUser

public void unsubscribeUser(java.lang.String user)

Unsubscribe remote user and send message to that user.

Specified by:

unsubscribeUser in interface XMPPSession

Parameters:

user - the full ID of remote user.

unsubscribeUser

public void unsubscribeUser(java.lang.String toUser,
                            java.lang.String serviceName)

Unsubscribe remote user and send message to that user.

Specified by:

unsubscribeUser in interface XMPPSession

Parameters:

toUser - the remote user.

serviceName - the service name.

messageReceive

public void messageReceive(java.lang.String messageId)

Set that message is received.

Specified by:

messageReceive in interface XMPPSession

Parameters:

messageId - the id of message

getSessionProvider

public org.exoplatform.services.jcr.ext.common.SessionProvider getSessionProvider()

Returns:

the sessionProvider

getMultiUserChat

public org.jivesoftware.smackx.muc.MultiUserChat getMultiUserChat(java.lang.String room)
                                                           throws org.jivesoftware.smack.XMPPException

Specified by:

getMultiUserChat in interface XMPPSession

Parameters:

room - the name of room

Returns:

the MultiuserChat

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

createRoom

public FormBean createRoom(java.lang.String room,
                           java.lang.String nickname)
                    throws org.jivesoftware.smack.XMPPException

Create new group chat.

Specified by:

createRoom in interface XMPPSession

Parameters:

room - the room name

nickname - the nickname in this room

Returns:

new MultiUserChat

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

getConfigFormRoom

public FormBean getConfigFormRoom(java.lang.String room)
                           throws org.jivesoftware.smack.XMPPException

get configuration form for group chat.

Specified by:

getConfigFormRoom in interface XMPPSession

Parameters:

room - the room name

Returns:

the configuration form of MultiUserChat

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

configRoom

public org.jivesoftware.smackx.muc.MultiUserChat configRoom(java.lang.String room,
                                                            ConfigRoomBean cr)
                                                     throws org.jivesoftware.smack.XMPPException

Configure the group chat.

Specified by:

configRoom in interface XMPPSession

Parameters:

room - the room name

cr - the configuration of group chat

Returns:

the MultiUserChat

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

isPasswordRequired

public boolean isPasswordRequired(java.lang.String room)

Parameters:

roomJID - the room id

Returns:

true if password required

joinRoom

public void joinRoom(java.lang.String room,
                     java.lang.String nickname,
                     java.lang.String password)
              throws org.jivesoftware.smack.XMPPException

Join to the group chat.

Specified by:

joinRoom in interface XMPPSession

Parameters:

room - the room name

nickname - the nickname

password - the password

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

getRooms

public InitInfoBean getRooms(java.lang.Integer from,
                             java.lang.Integer to,
                             java.lang.String sort)
                      throws org.jivesoftware.smack.XMPPException

Throws:

org.jivesoftware.smack.XMPPException

changeSubject

public void changeSubject(java.lang.String room,
                          java.lang.String newSubject)
                   throws org.jivesoftware.smack.XMPPException

Change subject of the room.

Specified by:

changeSubject in interface XMPPSession

Parameters:

room - the room name

newSubject - the new subject

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

changeAvailabilityStatusInRoom

public void changeAvailabilityStatusInRoom(java.lang.String room,
                                           java.lang.String status,
                                           java.lang.String mode)
                                    throws org.jivesoftware.smack.XMPPException

Change status in the room (e.g Extend Away).

Specified by:

changeAvailabilityStatusInRoom in interface XMPPSession

Parameters:

room - the room name

status - the status

mode - the mode

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

getJoinedRooms

public java.util.List<java.lang.String> getJoinedRooms()

Get already joined rooms.

Specified by:

getJoinedRooms in interface XMPPSession

Returns:

the joined rooms

getRoomInfoBean

public FullRoomInfoBean getRoomInfoBean(java.lang.String room)
                                 throws org.jivesoftware.smack.XMPPException

Get full information about room.

Specified by:

getRoomInfoBean in interface XMPPSession

Parameters:

room - the name of room

Returns:

the fullRoomInfoBean

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

getRoomInfo

public org.jivesoftware.smackx.muc.RoomInfo getRoomInfo(java.lang.String room)
                                                 throws org.jivesoftware.smack.XMPPException

Specified by:

getRoomInfo in interface XMPPSession

Throws:

org.jivesoftware.smack.XMPPException

declineRoom

public void declineRoom(java.lang.String room,
                        java.lang.String inviter,
                        java.lang.String reason)

Decline the invitation to the room.

Specified by:

declineRoom in interface XMPPSession

Parameters:

room - the room

inviter - the inviter

reason - the reason

inviteToRoom

public java.lang.Boolean inviteToRoom(java.lang.String room,
                                      java.lang.String invitee,
                                      java.lang.String reason)
                               throws org.jivesoftware.smack.XMPPException

Invite to the room.

Specified by:

inviteToRoom in interface XMPPSession

Parameters:

room - the room name

invitee - the invitee

reason - the reason

Returns:

true if successfully

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

leaveRoom

public java.lang.Boolean leaveRoom(java.lang.String room)
                            throws org.jivesoftware.smack.XMPPException

Leave the room.

Specified by:

leaveRoom in interface XMPPSession

Parameters:

room - the room name

Returns:

true if successfully

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

manageRole

public void manageRole(java.lang.String room,
                       java.lang.String nickname,
                       java.lang.String role,
                       java.lang.String command)
                throws org.jivesoftware.smack.XMPPException

The manage role of user in the room.

Specified by:

manageRole in interface XMPPSession

nickname - the nickname

role - the role

command - the command (grant or revoke)

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

kickUser

public void kickUser(java.lang.String room,
                     java.lang.String nickname,
                     java.lang.String reason)
              throws org.jivesoftware.smack.XMPPException

Specified by:

kickUser in interface XMPPSession

nickname - the nickname

reason - the reason

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

banUser

public void banUser(java.lang.String room,
                    java.lang.String nickname,
                    java.lang.String reason)
             throws org.jivesoftware.smack.XMPPException

Specified by:

banUser in interface XMPPSession

nickname - the username

reason - the reason

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

changeNickname

public void changeNickname(java.lang.String room,
                           java.lang.String nickname)
                    throws org.jivesoftware.smack.XMPPException

Change nickname in the room.

Specified by:

changeNickname in interface XMPPSession

Parameters:

room - the room name

nickname - the new nickname

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

destroyRoom

public java.lang.Boolean destroyRoom(java.lang.String room,
                                     java.lang.String reason,
                                     java.lang.String altRoom)
                              throws org.jivesoftware.smack.XMPPException

Destroy the group chat.

Specified by:

destroyRoom in interface XMPPSession

Parameters:

room - the room name

reason - the reason

altRoom - the name of alter room

Returns:

true if success

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

manageAffiliation

public void manageAffiliation(java.lang.String room,
                              java.lang.String nickname,
                              java.lang.String affiliation,
                              java.lang.String command)
                       throws org.jivesoftware.smack.XMPPException

Specified by:

manageAffiliation in interface XMPPSession

nickname - the username

affiliation - the affiliate

command - the command (grant or revoke)

Throws:

org.jivesoftware.smack.XMPPException - the XMPPException

getFileTransferRequest

public org.jivesoftware.smackx.filetransfer.FileTransferRequest getFileTransferRequest(java.lang.String uuid)

Parameters:

uuid - the id

Returns:

the FileTransferRequest

sendFile

public void sendFile(java.lang.String requestor,
                     java.lang.String path,
                     java.lang.String description,
                     boolean isRoom)
              throws java.lang.Exception

Parameters:

requestor - the requestor

path - the path

description - the description

isRoom - true if file send to the group chat

Throws:

java.lang.Exception

rejectFile

public void rejectFile(java.lang.String uuid)

Parameters:

uuid - the id

sendErrorMessage

public void sendErrorMessage(java.lang.String msg,
                             java.lang.String sender)