jadex.platform.service.chat

Class ChatService

java.lang.Object

jadex.platform.service.chat.ChatService

All Implemented Interfaces:

jadex.bridge.service.types.chat.IChatGuiService, jadex.bridge.service.types.chat.IChatService

public class ChatService
extends java.lang.Object
implements jadex.bridge.service.types.chat.IChatService, jadex.bridge.service.types.chat.IChatGuiService

Chat service implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ChatService.PropProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected jadex.bridge.IInternalAccess	agent The agent.
protected byte[]	image The image.
protected java.lang.String	nick The local nick name.
protected boolean	running Flag to avoid duplicate initialization/shutdown due to duplicate use of implementation.
protected java.lang.String	status The current status (idle, typing, away).
protected java.util.Set<jadex.commons.future.SubscriptionIntermediateFuture<jadex.bridge.service.types.chat.ChatEvent>>	subscribers The futures of active subscribers.
protected java.util.Map<java.lang.String,jadex.commons.Tuple3<jadex.bridge.service.types.chat.TransferInfo,jadex.commons.future.TerminableIntermediateFuture<java.lang.Long>,jadex.bridge.IInputConnection>>	transfers The currently managed file transfers.
protected java.util.Map<java.lang.String,jadex.commons.Tuple3<jadex.bridge.service.types.chat.TransferInfo,jadex.commons.future.ITerminableFuture<jadex.bridge.IOutputConnection>,jadex.bridge.IConnection>>	transfers2

Fields inherited from interface jadex.bridge.service.types.chat.IChatService

STATE_AWAY, STATE_DEAD, STATE_IDLE, STATE_TYPING

Constructor Summary

Constructors

Constructor and Description
ChatService()

Method Summary

Modifier and Type	Method and Description
jadex.commons.future.IFuture<java.lang.Void>	acceptFile(java.lang.String id, java.lang.String filepath) Accept a waiting file transfer.
jadex.commons.future.IFuture<java.lang.Void>	cancelTransfer(java.lang.String id) Cancel an ongoing file transfer.
protected void	doDownload(jadex.bridge.service.types.chat.TransferInfo ti, jadex.commons.future.TerminableIntermediateFuture<java.lang.Long> ret, jadex.bridge.IInputConnection con) Perform a download.
protected void	doUpload(jadex.bridge.service.types.chat.TransferInfo ti, jadex.bridge.IOutputConnection ocon, jadex.bridge.IComponentIdentifier receiver) Perform an upload.
jadex.commons.future.IIntermediateFuture<jadex.bridge.service.types.chat.IChatService>	findUsers() Search for available chat services.
jadex.commons.future.IIntermediateFuture<jadex.bridge.service.types.chat.TransferInfo>	getFileTransfers() Get a snapshot of the currently managed file transfers.
jadex.commons.future.IFuture<byte[]>	getImage() Get the image.
jadex.commons.future.IFuture<java.lang.String>	getNickName() Get the user name.
jadex.commons.future.IFuture<java.lang.String>	getStatus() Get the current status.
protected java.lang.String	getSubname() Get the "semi-qualified" sub name for settings.
jadex.commons.future.IIntermediateFuture<jadex.bridge.service.types.chat.IChatService>	message(java.lang.String text, jadex.bridge.IComponentIdentifier[] receivers, boolean self) Post a message.
jadex.commons.future.IFuture<java.lang.Void>	message(java.lang.String nick, java.lang.String text, boolean privatemessage) Post a message
protected boolean	publishEvent(java.lang.String type, java.lang.String nick, jadex.bridge.IComponentIdentifier cid, java.lang.Object value) Post an event to registered subscribers.
protected boolean	publishEvent(java.lang.String type, java.lang.String nick, jadex.bridge.IComponentIdentifier cid, java.lang.Object value, boolean privatemessage, byte[] image) Post an event to registered subscribers.
jadex.commons.future.IFuture<java.lang.Void>	rejectFile(java.lang.String id) Reject a waiting file transfer.
jadex.commons.future.IFuture<java.lang.Void>	sendFile(java.lang.String filepath, jadex.bridge.IComponentIdentifier cid) Send a local file to the target component.
jadex.commons.future.ITerminableIntermediateFuture<java.lang.Long>	sendFile(java.lang.String nick, java.lang.String filename, long size, java.lang.String id, jadex.bridge.IInputConnection con) Send a file.
protected jadex.commons.future.IFuture<jadex.bridge.service.types.chat.IChatService>	sendTo(java.lang.String text, jadex.bridge.IComponentIdentifier rec, boolean privatemessage) Helper method for sending message to cid.
jadex.commons.future.IFuture<java.lang.Void>	setImage(byte[] image) Set the image.
jadex.commons.future.IFuture<java.lang.Void>	setNickName(java.lang.String nick) Set the user name.
jadex.commons.future.IFuture<java.lang.Void>	shutdown() Called on shutdown.
jadex.commons.future.IFuture<java.lang.Void>	start() Called on startup.
jadex.commons.future.ITerminableFuture<jadex.bridge.IOutputConnection>	startUpload(java.lang.String nick, java.lang.String filename, long size, java.lang.String id) Send a file.
jadex.commons.future.IIntermediateFuture<jadex.bridge.service.types.chat.IChatService>	status(java.lang.String status, byte[] image, jadex.bridge.IComponentIdentifier[] receivers) Post a status change.
jadex.commons.future.IFuture<java.lang.Void>	status(java.lang.String nick, java.lang.String status, byte[] image) Post a status change.
protected jadex.commons.future.IFuture<jadex.bridge.service.types.chat.IChatService>	statusTo(java.lang.String nick, java.lang.String status, byte[] image, jadex.bridge.IComponentIdentifier rec) Helper method for posting status to cid.
jadex.commons.future.ISubscriptionIntermediateFuture<jadex.bridge.service.types.chat.ChatEvent>	subscribeToEvents() Subscribe to events from the chat service.

Methods inherited from class java.lang.Object

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

Field Detail

agent

protected jadex.bridge.IInternalAccess agent

The agent.

subscribers

protected java.util.Set<jadex.commons.future.SubscriptionIntermediateFuture<jadex.bridge.service.types.chat.ChatEvent>> subscribers

The futures of active subscribers.

nick

protected java.lang.String nick

The local nick name.

status

protected java.lang.String status

The current status (idle, typing, away).

transfers

protected java.util.Map<java.lang.String,jadex.commons.Tuple3<jadex.bridge.service.types.chat.TransferInfo,jadex.commons.future.TerminableIntermediateFuture<java.lang.Long>,jadex.bridge.IInputConnection>> transfers

The currently managed file transfers.

transfers2

protected java.util.Map<java.lang.String,jadex.commons.Tuple3<jadex.bridge.service.types.chat.TransferInfo,jadex.commons.future.ITerminableFuture<jadex.bridge.IOutputConnection>,jadex.bridge.IConnection>> transfers2

running

protected boolean running

Flag to avoid duplicate initialization/shutdown due to duplicate use of implementation.

image

protected byte[] image

The image.

Constructor Detail

ChatService

public ChatService()

Method Detail

start

public jadex.commons.future.IFuture<java.lang.Void> start()

Called on startup.

shutdown

public jadex.commons.future.IFuture<java.lang.Void> shutdown()

Called on shutdown.

getSubname

protected java.lang.String getSubname()

Get the "semi-qualified" sub name for settings.

message

public jadex.commons.future.IFuture<java.lang.Void> message(java.lang.String nick,
                                                            java.lang.String text,
                                                            boolean privatemessage)

Post a message

Specified by:

message in interface jadex.bridge.service.types.chat.IChatService

Parameters:

text - The text message.

status

public jadex.commons.future.IFuture<java.lang.Void> status(java.lang.String nick,
                                                           java.lang.String status,
                                                           byte[] image)

Post a status change.

Specified by:

status in interface jadex.bridge.service.types.chat.IChatService

Parameters:

status - The new status.

getStatus

public jadex.commons.future.IFuture<java.lang.String> getStatus()

Get the current status.

Specified by:

getStatus in interface jadex.bridge.service.types.chat.IChatService

sendFile

public jadex.commons.future.ITerminableIntermediateFuture<java.lang.Long> sendFile(java.lang.String nick,
                                                                                   java.lang.String filename,
                                                                                   long size,
                                                                                   java.lang.String id,
                                                                                   jadex.bridge.IInputConnection con)

Send a file.

Specified by:

sendFile in interface jadex.bridge.service.types.chat.IChatService

Parameters:

nick - The sender's nick name.

filename - The filename.

size - The size of the file.

id - An optional id to identify the transfer (e.g. for resume after error).

con - The connection.

Returns:

The returned future publishes updates about the total number of bytes received. Exception messages of the returned future correspond to file transfer states (aborted vs. error vs. rejected).

startUpload

public jadex.commons.future.ITerminableFuture<jadex.bridge.IOutputConnection> startUpload(java.lang.String nick,
                                                                                          java.lang.String filename,
                                                                                          long size,
                                                                                          java.lang.String id)

Send a file. Alternative method signature.

Specified by:

startUpload in interface jadex.bridge.service.types.chat.IChatService

Parameters:

nick - The sender's nick name.

filename - The filename.

size - The size of the file.

id - An optional id to identify the transfer (e.g. for resume after error).

Returns:

When the upload is accepted, the output connection for sending the file is returned.

setNickName

public jadex.commons.future.IFuture<java.lang.Void> setNickName(java.lang.String nick)

Set the user name.

Specified by:

setNickName in interface jadex.bridge.service.types.chat.IChatGuiService

getNickName

public jadex.commons.future.IFuture<java.lang.String> getNickName()

Get the user name.

Specified by:

getNickName in interface jadex.bridge.service.types.chat.IChatGuiService

Specified by:

getNickName in interface jadex.bridge.service.types.chat.IChatService

setImage

public jadex.commons.future.IFuture<java.lang.Void> setImage(byte[] image)

Set the image.

Specified by:

setImage in interface jadex.bridge.service.types.chat.IChatGuiService

getImage

public jadex.commons.future.IFuture<byte[]> getImage()

Get the image.

Specified by:

getImage in interface jadex.bridge.service.types.chat.IChatGuiService

Specified by:

getImage in interface jadex.bridge.service.types.chat.IChatService

subscribeToEvents

public jadex.commons.future.ISubscriptionIntermediateFuture<jadex.bridge.service.types.chat.ChatEvent> subscribeToEvents()

Subscribe to events from the chat service.

Specified by:

subscribeToEvents in interface jadex.bridge.service.types.chat.IChatGuiService

Returns:

A future publishing chat events as intermediate results.

findUsers

public jadex.commons.future.IIntermediateFuture<jadex.bridge.service.types.chat.IChatService> findUsers()

Search for available chat services.

Specified by:

findUsers in interface jadex.bridge.service.types.chat.IChatGuiService

Returns:

The currently available remote services.

message

public jadex.commons.future.IIntermediateFuture<jadex.bridge.service.types.chat.IChatService> message(java.lang.String text,
                                                                                                      jadex.bridge.IComponentIdentifier[] receivers,
                                                                                                      boolean self)

Post a message. Searches for available chat services and posts the message to all.

Specified by:

message in interface jadex.bridge.service.types.chat.IChatGuiService

Parameters:

text - The text message.

Returns:

The remote services, to which the message was successfully posted.

sendTo

protected jadex.commons.future.IFuture<jadex.bridge.service.types.chat.IChatService> sendTo(java.lang.String text,
                                                                                            jadex.bridge.IComponentIdentifier rec,
                                                                                            boolean privatemessage)

Helper method for sending message to cid.

status

public jadex.commons.future.IIntermediateFuture<jadex.bridge.service.types.chat.IChatService> status(java.lang.String status,
                                                                                                     byte[] image,
                                                                                                     jadex.bridge.IComponentIdentifier[] receivers)

Post a status change.

Specified by:

status in interface jadex.bridge.service.types.chat.IChatGuiService

Parameters:

status - The new status or null for no change.

image - The new avatar image or null for no change.

statusTo

protected jadex.commons.future.IFuture<jadex.bridge.service.types.chat.IChatService> statusTo(java.lang.String nick,
                                                                                              java.lang.String status,
                                                                                              byte[] image,
                                                                                              jadex.bridge.IComponentIdentifier rec)

Helper method for posting status to cid.

getFileTransfers

public jadex.commons.future.IIntermediateFuture<jadex.bridge.service.types.chat.TransferInfo> getFileTransfers()

Get a snapshot of the currently managed file transfers.

Specified by:

getFileTransfers in interface jadex.bridge.service.types.chat.IChatGuiService

acceptFile

public jadex.commons.future.IFuture<java.lang.Void> acceptFile(java.lang.String id,
                                                               java.lang.String filepath)

Accept a waiting file transfer.

Specified by:

acceptFile in interface jadex.bridge.service.types.chat.IChatGuiService

Parameters:

id - The transfer id.

filepath - The location of the file (possibly changed by user).

rejectFile

public jadex.commons.future.IFuture<java.lang.Void> rejectFile(java.lang.String id)

Reject a waiting file transfer.

Specified by:

rejectFile in interface jadex.bridge.service.types.chat.IChatGuiService

Parameters:

id - The transfer id.

cancelTransfer

public jadex.commons.future.IFuture<java.lang.Void> cancelTransfer(java.lang.String id)

Cancel an ongoing file transfer.

Specified by:

cancelTransfer in interface jadex.bridge.service.types.chat.IChatGuiService

Parameters:

id - The transfer id.

sendFile

public jadex.commons.future.IFuture<java.lang.Void> sendFile(java.lang.String filepath,
                                                             jadex.bridge.IComponentIdentifier cid)

Send a local file to the target component.

Specified by:

sendFile in interface jadex.bridge.service.types.chat.IChatGuiService

Parameters:

filepath - The file path, local to the chat component.

cid - The id of a remote chat component.

publishEvent

protected boolean publishEvent(java.lang.String type,
                               java.lang.String nick,
                               jadex.bridge.IComponentIdentifier cid,
                               java.lang.Object value)

Post an event to registered subscribers.

Parameters:

type - The event type.

nick - The nick name.

cid - The component ID.

value - The event value.

publishEvent

protected boolean publishEvent(java.lang.String type,
                               java.lang.String nick,
                               jadex.bridge.IComponentIdentifier cid,
                               java.lang.Object value,
                               boolean privatemessage,
                               byte[] image)

Post an event to registered subscribers.

Parameters:

type - The event type.

nick - The nick name.

cid - The component ID.

value - The event value.

doDownload

protected void doDownload(jadex.bridge.service.types.chat.TransferInfo ti,
                          jadex.commons.future.TerminableIntermediateFuture<java.lang.Long> ret,
                          jadex.bridge.IInputConnection con)

Perform a download.

doUpload

protected void doUpload(jadex.bridge.service.types.chat.TransferInfo ti,
                        jadex.bridge.IOutputConnection ocon,
                        jadex.bridge.IComponentIdentifier receiver)

Perform an upload. Called from file sender. Writes bytes from file input stream to output connection.