com.jivesoftware.community.webservices
Interface IMService

public interface IMService

Provides a the ability for managing real time comunication.

Method Summary

void	configureComponent(java.lang.String domain, java.util.List<java.lang.String> hosts, int port) Tries to connect to XMPP server.
WSJiveObject	noOp() Hack to elimite SEVERE errors logged by celtix because the UnauthorizedException isn't getting registered properly in the generated schema and can't be found as an xml type when searching by QName.
void	testCredentials() Test if user's credentials are OK and have enough permissions.
void	updateSharedSecret(java.lang.String newSecret) Updates the shared secret and resets the connection using it.

Method Detail

configureComponent

void configureComponent(java.lang.String domain,
                        java.util.List<java.lang.String> hosts,
                        int port)
                        throws org.xmpp.component.ComponentException

Tries to connect to XMPP server. Since the server could have several host names this method will try to connect using each one. When it founds a host/port combination that works it stops trying and saves that configuration.

Parameters:

domain - the domain of Openfire

hosts - a list of possible host address of Openfire, comma separated

port - the port of external components of Openfire

Throws:

org.xmpp.component.ComponentException - if there was an error connecting the component.

updateSharedSecret

void updateSharedSecret(java.lang.String newSecret)

Updates the shared secret and resets the connection using it.

Parameters:

newSecret - the new shared secret

testCredentials

void testCredentials()

Test if user's credentials are OK and have enough permissions. Throws an UnauthorizedException if user is not loged in or it doesn't have enough permissions.

noOp

WSJiveObject noOp()

Hack to elimite SEVERE errors logged by celtix because the UnauthorizedException isn't getting registered properly in the generated schema and can't be found as an xml type when searching by QName.

Returns:

throws UnsupportedOperationException