com.atlassian.bamboo.instantmessagingserver
Interface InstantMessagingServerManager

All Known Implementing Classes:

InstantMessagingServerManagerImpl

public interface InstantMessagingServerManager

Method Summary

java.util.Collection	getAllInstantMessagingServers() Returns all InstantMessagingServerDefinition objects
InstantMessagingServerDefinition	getInstantMessagingServer(long instantMessagingServerId) Returns the InstantMessagingServerDefinition that matches the passed id
void	removeInstantMessagingServer(long instantMessagingServerId) Removes the InstantMessagingServerDefinition with the matching id
void	saveInstantMessagingServer(InstantMessagingServerDefinition instantMessagingServer) Stores the InstantMessagingServerDefinition.
void	sendMessage(InstantMessagingServerDefinition server, java.util.Set recipients, java.lang.String message) Deprecated. - use BambooSmackClient

Method Detail

getAllInstantMessagingServers

java.util.Collection getAllInstantMessagingServers()

Returns all InstantMessagingServerDefinition objects

Returns:

An unmodifiable collection of InstantMessagingServerDefinition objects, Collections.EMPTY_LIST if none exists.

saveInstantMessagingServer

void saveInstantMessagingServer(InstantMessagingServerDefinition instantMessagingServer)

Stores the InstantMessagingServerDefinition.

Parameters:

instantMessagingServer - - Must not be null

getInstantMessagingServer

InstantMessagingServerDefinition getInstantMessagingServer(long instantMessagingServerId)

Returns the InstantMessagingServerDefinition that matches the passed id

Parameters:

instantMessagingServerId -

Returns:

Matching InstantMessagingServerDefinition object. Null if the server does not exist

removeInstantMessagingServer

void removeInstantMessagingServer(long instantMessagingServerId)

Removes the InstantMessagingServerDefinition with the matching id

Parameters:

instantMessagingServerId -

Throws:

java.lang.IllegalArgumentException - - is thrown if server does not exist

sendMessage

void sendMessage(InstantMessagingServerDefinition server,
                 java.util.Set recipients,
                 java.lang.String message)
                 throws org.jivesoftware.smack.XMPPException

Deprecated. - use BambooSmackClient

Sends a test message

Parameters:

server -

recipients -

message -

Throws:

org.jivesoftware.smack.XMPPException