JBoss.orgCommunity Documentation

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

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

The Resource Adaptor Type defines one activity object, net.java.slee.resource.tftp.TransferActivity.

The TransferActivity represents a TFTP transfer. It is created on reception of a TFTP requests, and ends on end-of-file, closure of the datastream, or by an SBB invoking sendError() on the TransferActivity Object. The activity object interface is defined as follows:



        
package net.java.slee.resource.tftp;
public interface TransferActivity {
    public String getTransferId();
    public InputStream getInputStream() throws IOException;
    public OutputStream getOutputStream() throws IOException;
    public void receiveFile(String filename) throws FileNotFoundException, IOException;
    public void receiveFile(File file) throws FileNotFoundException, IOException;
    public void sendFile(String filename) throws FileNotFoundException, IOException;
    public void sendFile(File file) throws FileNotFoundException, IOException;
    public void sendError(int errorCode, String reason);
}
     

The Events fired by TFTP Server Resource Adaptor represent an incoming TFTP Request. 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.

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



        
package net.java.slee.resource.tftp.events;
import org.apache.commons.net.tftp.TFTPPacket;
public interface RequestEvent {
    public TFTPPacket getRequest(); 
    public String getTypeDescr();
    public String getId();
}
     
The getRequest() method:

Retrieves the TFTP request packet which is associated with the event.

The getTypeDescr() method:

Retrieves the type description associated with the request.

The getId() method:

Retrieves unique event ID.

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

The following code handles a TFTP WRITE request:



            
    import net.java.slee.resource.tftp.TransferActivity;
    import net.java.slee.resource.tftp.events.RequestEvent;
    import org.apache.commons.net.tftp.TFTPWriteRequestPacket;
    import org.apache.commons.net.tftp.TFTPRequestPacket;
    public void onWrite(RequestEvent event, ActivityContextInterface aci) {
        TFTPWriteRequestPacket req = (TFTPWriteRequestPacket) event.getRequest();
        if (isSpecialRequest(req) {
            doSpecialThings(req);
        } else {
            // just receive data and create the requested file
            TransferActivity activity = (TransferActivity) aci.getActivity();
            try {
                activity.receiveFile(req.getFilename());
            } catch (FileNotFoundException e) {
                activity.sendError(TFTPErrorPacket.FILE_NOT_FOUND, e.getMessage());
                return;
            } catch (Exception e) {
                activity.sendError(TFTPErrorPacket.UNDEFINED, e.getMessage());
                return;
            }
        }
    }
    private boolean isSpecialRequest(TFTPRequestPacket packet) {
        // inspect packet and decide whether it needs special treatment
        return false;
    }
    private void doSpecialThings(TFTPRequestPacket packet) {
        // actually do the special things that need to be done.
        ...;
    }
        

The following code handles a TFTP READ request:



            
    import net.java.slee.resource.tftp.TransferActivity;
    import net.java.slee.resource.tftp.events.RequestEvent;
    import org.apache.commons.net.tftp.TFTPReadRequestPacket;
    import org.apache.commons.net.tftp.TFTPRequestPacket;
    // CMP fields
    public abstract void setSuspendedEventCmp(EventContext ctxt);
    public abstract EventContext getSuspendedEventCmp();
    public void onRead(RequestEvent event, ActivityContextInterface aci,
                        EventContext ctxt) {
        TFTPReadRequestPacket req = (TFTPReadRequestPacket) event.getRequest();
        if (isSpecialRequest(req) {
            doSpecialThings(req);
        } else {
            // just send the requested file
            TransferActivity activity = (TransferActivity) aci.getActivity();
            try {
                activity.sendFile(req.getFilename());
            } catch (FileNotFoundException e) {
                activity.sendError(TFTPErrorPacket.FILE_NOT_FOUND, e.getMessage());
                return;
            } catch (Exception e) {
                activity.sendError(TFTPErrorPacket.UNDEFINED, e.getMessage());
                return;
            }
        }
    }
    private boolean isSpecialRequest(TFTPRequestPacket packet) {
        // inspect packet and decide whether it needs special treatment
        return false;
    }
    private void doSpecialThings(TFTPRequestPacket packet, EventContext ctxt) {
        // actually do the special things that need to be done & suspend.
        ...;
        setSuspendedEventCmp(ctxt);
        ctxt.suspendDelivery();
    }
    public void onSomeOtherRelatedEvent(RelatedEvent event, ActivityContextInterface aci) {
        try {
            OutputStream os = getRequestActivity().getOutputStream();
            os.write("whatever data needs to be written".getBytes());
            os.flush(); os.close();
            getSuspendedEventCmp().resumeDelivery();
        } catch (Exception e) {
            
        }
    }
    private TransferActivity getRequestActivity() {
        for (ActivityContextInterface aci : sbbContext.getActivities())
            if (aci.getActivity() instanceof TransferActivity)
                return (TransferActivity) aci.getActivity();
        return null;
    }
        

This chapter documents the TFTP Server 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 TftpServerResourceAdaptor, its vendor is org.mobicents and its version is 1.0.

  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/tftp-server, then add the specific release version, lets consider 1.0.0.BETA1.

    [usr]$ svn co http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/tftp-server/1.0.0.BETA1 slee-ra-tftp-server-1.0.0.BETA1
  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-tftp-server-1.0.0.BETA1
    				    [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/tftp-server.

Revision History
Revision 1.0Fri Apr 1 2011Tom Uijldert
Creation of the Mobicents JAIN SLEE TFTP Server RA User Guide.