JBoss.orgCommunity Documentation

Mobicents JAIN SLEE HTTP Servlet Resource Adaptor User Guide


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 Mobicents JAIN SLEE HTTP Servlet Resource Adaptor, or contact the authors.

When submitting a bug report, be sure to mention the manual's identifier: JAIN_SLEE_HttpServlet_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 HttpServletResourceAdaptorType, its vendor is org.mobicents and its version is 1.0.

The Events fired by HTTP Servlet Resource Adaptor represent an incoming HTTP Request, and for each HTTP Request a different event type is used for each activity type. The table below lists the Resource Adaptor Type event types.


Important

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


Important

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

All event types use the same type net.java.slee.resource.http.events.HttpServletRequestEvent. It's interface is as follows:



        
package net.java.slee.resource.http.events;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public interface HttpServletRequestEvent {
    
    public HttpServletRequest getRequest(); 
    
    public HttpServletResponse getResponse();
    
    public String getId();
}
     
The getRequest() method:

Retrieves the HttpServletRequest which is associated with the event.

The getResponse() method:

Retrieves the HttpServletResponse which is associated with the request, which can be used to reply to the incoming request.

The getId() method:

Retrieves unique event ID.

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

The following code examples the handling of an HTTP PUT request, and the creation of an HttpSessionActivity:



            
    public void onPut(HttpServletRequestEvent event,
            ActivityContextInterface aci) {
        
        SbbLocalObject sbbLocalObject = sbbContext.getSbbLocalObject();
        // detach from HttpServletRequestActivity
        aci.detach(sbbLocalObject);
        try {
            // here we will setup a session activity before sending the response back
            if (httpServletRaSbbInterface == null) {
                Context myEnv = (Context) new InitialContext().lookup("java:comp/env"); 
                httpServletRaSbbInterface = (HttpServletRaSbbInterface) myEnv.lookup(
                    "slee/resources/mobicents/httpservlet/sbbrainterface");
                httpServletRaActivityContextInterfaceFactory = 
                    (HttpServletRaActivityContextInterfaceFactory) myEnv.lookup(
                        "slee/resources/mobicents/httpservlet/acifactory");
            }
            HttpSession httpSession = event.getRequest().getSession();
            HttpSessionActivity httpSessionActivity = httpServletRaSbbInterface
                    .getHttpSessionActivity(httpSession);
            ActivityContextInterface httpSessionActivityContextInterface = 
                httpServletRaActivityContextInterfaceFactory
                    .getActivityContextInterface(httpSessionActivity);
            httpSessionActivityContextInterface.attach(sbbLocalObject);
            HttpServletResponse response = event.getResponse();
            PrintWriter w = response.getWriter();
            w.print("onPut OK! Served by SBB = " + getSbbId());
            w.flush();
            response.flushBuffer();
            log.info("HttpServletRAExampleSbb: PUT Request received and OK! response sent.");
        } catch (Exception e) {
            log.error(e);
        }
    }
        

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

The name of the RA is HttpServletResourceAdaptor, its vendor is org.mobicents and its version is 1.0.

There is a single Resource Adaptor Entity created when deploying the Resource Adaptor, named HttpServletRA.

The HttpServletRA entity is also bound to Resource Adaptor Link Name HttpServletRA, to use it in an Sbb add the following XML to its descriptor:



        <resource-adaptor-type-binding>
            <resource-adaptor-type-ref>
                <resource-adaptor-type-name>
                    HttpServletResourceAdaptorType
                </resource-adaptor-type-name>
                <resource-adaptor-type-vendor>
                    org.mobicents
                </resource-adaptor-type-vendor>
                <resource-adaptor-type-version>
                    1.0
                </resource-adaptor-type-version>
            </resource-adaptor-type-ref>
            <activity-context-interface-factory-name>
                slee/resources/mobicents/httpservlet/acifactory
            </activity-context-interface-factory-name>
            <resource-adaptor-entity-binding>
                <resource-adaptor-object-name>
                    slee/resources/mobicents/httpservlet/sbbrainterface
                </resource-adaptor-object-name>
                <resource-adaptor-entity-link>
                    HttpServletRA
                </resource-adaptor-entity-link>
            </resource-adaptor-entity-binding>
        </resource-adaptor-type-binding>
    

  1. Downloading the source code

    Use SVN to checkout a specific release source, the base URL is http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/http-servlet, then add the specific release version, lets consider 2.4.0.FINAL.

    [usr]$ svn co http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/http-servlet/2.4.0.FINAL slee-ra-http-servlet-2.4.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-http-servlet-2.4.0.FINAL
    				    [usr]$ mvn install
    				    

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

Similar process as for Section 4.2.1, “Release Source Code Building”, the only change is the SVN source code URL, which is http://mobicents.googlecode.com/svn/trunk/servers/jain-slee/resources/http-servlet.

Revision History
Revision 1.0Tue Dec 30 2009Eduardo Martins
Creation of the Mobicents JAIN SLEE HTTP Servlet RA User Guide.