net.java.sip.communicator.impl.protocol.mock
Class MockBasicInstantMessaging

java.lang.Object
  net.java.sip.communicator.service.protocol.AbstractOperationSetBasicInstantMessaging
      net.java.sip.communicator.impl.protocol.mock.MockBasicInstantMessaging

All Implemented Interfaces:

OperationSet, OperationSetBasicInstantMessaging

public class MockBasicInstantMessaging
extends AbstractOperationSetBasicInstantMessaging

Instant messaging functionality for the mock protocol.

Author:

Damian Minkov, Emil Ivov

Field Summary

Fields inherited from interface net.java.sip.communicator.service.protocol.OperationSetBasicInstantMessaging

DEFAULT_MIME_ENCODING, DEFAULT_MIME_TYPE, HTML_MIME_TYPE

Constructor Summary

MockBasicInstantMessaging(MockProvider provider, MockPersistentPresenceOperationSet opSetPersPresence)
Creates an instance of this operation set keeping a reference to the parent protocol provider and presence operation set.

Method Summary

Message	createMessage(String content, String contentType, String encoding, String subject) Create a Message instance for sending arbitrary MIME-encoding content.
void	deliverMessage(String to, Message msg) Methods for manipulating mock operation set as deliver(receive) messageop
boolean	isContentTypeSupported(String contentType) Determines whether the protocol supports the supplied content type
boolean	isOfflineMessagingSupported() Determines whether the protocol provider (or the protocol itself) support sending and receiving offline messages.
void	sendInstantMessage(Contact to, Message message) Sends the message to the destination indicated by the to contact.

Methods inherited from class net.java.sip.communicator.service.protocol.AbstractOperationSetBasicInstantMessaging

addMessageListener, createMessage, createMessage, fireMessageDelivered, fireMessageDeliveryFailed, fireMessageEvent, fireMessageReceived, isContentTypeSupported, messageDeliveryPendingTransform, removeMessageListener

Methods inherited from class java.lang.Object

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

Constructor Detail

MockBasicInstantMessaging

public MockBasicInstantMessaging(MockProvider provider,
                                 MockPersistentPresenceOperationSet opSetPersPresence)

Creates an instance of this operation set keeping a reference to the parent protocol provider and presence operation set.

Parameters:

provider - The provider instance that creates us.

opSetPersPresence - the currently valid MockPersistentPresenceOperationSet instance.

Method Detail

createMessage

public Message createMessage(String content,
                             String contentType,
                             String encoding,
                             String subject)

Description copied from interface: OperationSetBasicInstantMessaging

Create a Message instance for sending arbitrary MIME-encoding content.

Specified by:

createMessage in interface OperationSetBasicInstantMessaging

Specified by:

createMessage in class AbstractOperationSetBasicInstantMessaging

Parameters:

content - content value

contentType - the MIME-type for content

encoding - encoding used for content

subject - a String subject or null for now subject.

Returns:

the newly created message.

sendInstantMessage

public void sendInstantMessage(Contact to,
                               Message message)
                        throws IllegalStateException,
                               IllegalArgumentException

Sends the message to the destination indicated by the to contact.

Parameters:

to - the Contact to send message to

message - the Message to send.

Throws:

IllegalStateException - if the underlying ICQ stack is not registered and initialized.

IllegalArgumentException - if to is not an instance belonging to the underlying implementation.

isOfflineMessagingSupported

public boolean isOfflineMessagingSupported()

Determines whether the protocol provider (or the protocol itself) support sending and receiving offline messages. Most often this method would return true for protocols that support offline messages and false for those that don't. It is however possible for a protocol to support these messages and yet have a particular account that does not (i.e. feature not enabled on the protocol server). In cases like this it is possible for this method to return true even when offline messaging is not supported, and then have the sendMessage method throw an OperationFailedException with code - OFFLINE_MESSAGES_NOT_SUPPORTED.

Returns:

true if the protocol supports offline messages and false otherwise.

isContentTypeSupported

public boolean isContentTypeSupported(String contentType)

Determines whether the protocol supports the supplied content type

Parameters:

contentType - the type we want to check

Returns:

true if the protocol supports it and false otherwise.

deliverMessage

public void deliverMessage(String to,
                           Message msg)

Methods for manipulating mock operation set as deliver(receive) messageop

Parameters:

to - the address of the contact whom we are to deliver the message.

msg - the message that we are to deliver.