JBoss.orgCommunity Documentation

JBoss Communications JAIN SLEE XMPP Resource Adaptor User Guide

by Eduardo Martins, Bartosz Baranowski, and Alexandre Mendonça

Abstract

TODO


This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.

In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default.

Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows.

Mono-spaced Bold

Used to highlight system input, including shell commands, file names and paths. Also used to highlight key caps and key-combinations. For example:

The above includes a file name, a shell command and a key cap, all presented in Mono-spaced Bold and all distinguishable thanks to context.

Key-combinations can be distinguished from key caps by the hyphen connecting each part of a key-combination. For example:

The first sentence highlights the particular key cap to press. The second highlights two sets of three key caps, each set pressed simultaneously.

If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in Mono-spaced Bold. For example:

Proportional Bold

This denotes words or phrases encountered on a system, including application names; dialogue box text; labelled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:

The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in Proportional Bold and all distinguishable by context.

Note the > shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow 'Select Mouse from the Preferences sub-menu in the System menu of the main menu bar' approach.

Mono-spaced Bold Italic or Proportional Bold Italic

Whether Mono-spaced Bold or Proportional Bold, the addition of Italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example:

Note the words in bold italics above username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system.

Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example:

If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in the the Issue Tracker, against the product JBoss Communications JAIN SLEE XMPP Resource Adaptor, or contact the authors.

When submitting a bug report, be sure to mention the manual's identifier: JAIN_SLEE_XMPP_RA_User_Guide

If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.

The Resource Adaptor Type is the interface which defines the contract between the RA implementations, the SLEE container, and the Applications running in it.

The name of the RA Type is XMPPResourceAdaptorType, its vendor is org.mobicents and its version is 2.0.

The Events fired by XMPP Resource Adaptor represent an incoming message, received in a specific XmppConnection activity. The table below lists the Resource Adaptor Type event types.


Important

Spaces where introduced in Name, Vendor and Event Class column values, to correctly render the table. Please remove them when using copy/paste.

Important

More details for each event type may be obtained on the javadocs of each event type class.

The XMPP Resource Adaptor interface, of type org.mobicents.slee.resource.xmpp.XmppResourceAdaptorSbbInterface , is used by an SBB to interact with XMPP resources. It is defined as follows:

  

package org.mobicents.slee.resource.xmpp;
import java.util.Collection;
import org.jivesoftware.smack.XMPPException;
import org.jivesoftware.smack.packet.Packet;
public interface XmppResourceAdaptorSbbInterface {
 public XmppConnection getXmppConnection(String connectionId);
 public void sendPacket(String connectionID, Packet packet);
 public XmppConnection connectClient(String connectionID, String serverHost,
   int serverPort, String serviceName, String username,
   String password, String resource, Collection packetFilters)
   throws XMPPException;
 public XmppConnection connectComponent(String connectionID,
   String serverHost, int serverPort, String serviceName,
   String componentName, String componentSecret,
   Collection packetFilters) throws XMPPException;
 
 public void disconnect(String connectionID);  
}
    

The following code examples shows how to use the Resource Adaptor Type for common functionalities

This chapter documents the XMPP Resource Adaptor Implementation details, such as the configuration properties, the default Resource Adaptor entities, and the JAIN SLEE 1.1 Tracers and Alarms used.

  1. Downloading the source code

    Use SVN to checkout a specific release source, the base URL is ?, then add the specific release version, lets consider 2.2.0.FINAL.

    [usr]$ svn co ?/2.2.0.FINAL slee-ra-xmpp-2.2.0.FINAL
  2. Building the source code

    Important

    Maven 2.0.9 (or higher) is used to build the release. Instructions for using Maven2, including install, can be found at http://maven.apache.org

    Use Maven to build the deployable unit binary.

    				    [usr]$ cd slee-ra-xmpp-2.2.0.FINAL
    				    [usr]$ mvn install
    				    

    Once the process finishes you should have the deployable-unit jar file in the target directory, if JBoss Communications JAIN SLEE is installed and environment variable JBOSS_HOME is pointing to its underlying JBoss Enterprise Application Platform directory, then the deployable unit jar will also be deployed in the container.

Revision History
Revision 1.0Tue Dec 30 2009Eduardo Martins
Creation of the JBoss Communications JAIN SLEE XMPP RA User Guide.