by SuperBonBon

Server scripts

Scripts

Beanshell scripts can be used for some messages send by the server to the client :

• Login message
• Logout message
• Disclamer message
• Server closed message

JAFS ships a sample scripts file in the config directory named scripts.xml. Each scripts file can contain multiple scripts that can be used for the server output messages described above.

You will need some Java programmer skills to create new scripts, however no skills are need to use the sample scripts provided with JAFS.

Use an existing script

To use a script edit the server configuration file and add a script identifier string into the desired message :

          <script name="sysTime" desc="the current system date">
          <![CDATA[
            Date dte = new Date();
            String frmt = "EEE d MMM yyyy HH:mm:ss Z";
            java.text.SimpleDateFormat format = new java.text.SimpleDateFormat( frmt );
            format.format( dte );
            ]]>
          </script>
        

          <server xmlns="http://www.sbbi.net/jafs/1.0/jafs-server"
            ...
            code="sample_server" ... >
            ....
            <loginMessage>Hello new client the system time is : ${sysTime}</loginMessage>
            ....
          </server>
        

          Resolving host name localhost...
          Connecting to (localhost) ->  IP: 127.0.0.1 PORT: 21
          Connected to (localhost) -> Time = 0ms
          Socket connected waiting for login sequence.
          220 Hello new client the system time is : Sun 5 Oct 2003 14:06:40 +0200
          USER username
          ...
        

Creating your own scripts

First you'll need to edit the script file and add an new xml <script> tag that match the grammar used by the other existing scripts tags.

You can also create your own script file and instruct JAFS to load this file, look at the service configuration file scriptload and scripts for more informations.

Once done, chose an unique script identifier string and add it to the name script attribute tag

In the script tag body add your code I.E :

        <script name="helloworld" desc="my first script">
          <![CDATA[
            return "hello world";
            ]]>
          </script>
      

You are done, follow the instructions above to output your sample script

This example is very basic, but remember : you can use the entire JAVA API with these scripts, such feature open huge horizion : you can connect to databases using JDBC, connect to remote servers to retreive data and much more..

Available JAFS variables in scripts

Some variable that represents JAFS objects are provided within scripts execution scope.

Example of the server variable use :

      <script name="maxConn" desc="the maximum number of connections">
      <[CDATA[
      server.getFtpServerConfig().getMaximumSessionsNumber();
      ]]>
      </script>
      

Take a look at the JAFS API documentation for more informations about those objects capabilities.

Scripts Programming errors

During each server startup JAFS executes all the scripts and immediatly stops if a programming error is found. This prevents to start the server with invalid scripts and allows you to do some debug.