iMService

Provides the ability to manage the real time comunication service provided by the Openfire XMPP server.

Method	Description
configureComponent	Configures the connection between SBS and the XMPP server.
generateNonce	Generates a new nonce that can be used to SSO from Openfire.
testCredentials	Tests the user's credentials to ensure that they have the required permissions.
updateSharedSecret	Updates the shared secret and resets the connection using it.

configureComponent

Configures the connection between SBS and the XMPP server. Since the server could have several host names, this will try to connect using each one. When it finds a host/port combination that works, it stops trying and saves that configuration.

POST http://domain:port/application_context/rpc/rest/iMService/configureComponent

Arguments

Name	Type	Description
domain	xs:string	The XMPP server domain.
hosts	xs:string	A list of possible host address of Openfire, comma separated.
port	xs:int	The port of external components of Openfire.

Arguments Template

<configureComponent> 
    <domain>xs:string</domain>
    <!-- List of ... -->
    <hosts>xs:string</hosts>
    <port>xs:int</port>
</configureComponent>

Errors

Error	When Returned
org.xmpp.component.ComponentException	If there was an error connecting the component.
Unauthorized	If not a system administrator.

generateNonce

Generates a new nonce that can be used to SSO from Openfire.

GET http://domain:port/application_context/rpc/rest/iMService/generateNonce

Response

Type	Description
	A new nonce.

Response Template

<generateNonceResponse> 
    <return>xs:string</return>
</generateNonceResponse>

Errors

Error	When Returned
Unauthorized	If the caller is not a system administrator.

testCredentials

Tests the user's credentials to ensure that they have the required permissions.

GET http://domain:port/application_context/rpc/rest/iMService/testCredentials

Errors

Error	When Returned
Unauthorized	If the caller is not a system administrator.

updateSharedSecret

Updates the shared secret and resets the connection using it. A shared secret is a phrase known to both SBS and the server and is used when connecting.

POST http://domain:port/application_context/rpc/rest/iMService/updateSharedSecret

Arguments

Name	Type	Description
newSecret	xs:string	The new shared secret.

Arguments Template

<updateSharedSecret> 
    <newSecret>xs:string</newSecret>
</updateSharedSecret>

Errors

Error	When Returned
Unauthorized	If the caller is not a system administrator.