MapleNet™ Installation and Licensing Guide

Version

Windows XP

Windows 7

Windows 8.1

Version

Windows XP

Windows 7

Windows 8.1

Windows Server® 2008 R2

Windows Server 2012

Version

Apple OS® X 10.8

Apple OS® X 10.9

Vendor

Operating System Version

Red Hat Enterprise Linux

6

SUSE Linux Enterprise Desktop

11

Ubuntu

12.04 LTS, 13.10

CentOS

6.5

Vendor

Operating System Version

Red Hat Enterprise Linux

6

SUSE Linux Enterprise Desktop

11

Ubuntu

12.04 LTS, 13.10

CentOS

6.5

# maplenet - start/stop script for invoking Tomcat
#           with a MapleNet environment setup
#           Also assume a 'maplenet' user has been created and is
#           owner of the Tomcat and MapleNet directories
#
# Check that JAVA_HOME is set
#
if [ -z "$JAVA_HOME" ] ; then
   #
   # Change to point at your Java installation
   export JAVA_HOME=/usr/local/java/jdk1.6.0_38
fi

#
# Point at the MapleNet startup script that sets
#  - Xvfb and the DISPLAY setting for server side generated graphics
#  - set maple environment
#  - starts Tomcat with this environment and DISPLAY
#
# *** Change to point at your MapleNet installation ***
m_pgm=/usr/local/tomcat6/webapps/maplenet/WEB-INF/bin/maplenet_ctl

#
# logging if desired
m_log1=/usr/local/tomcat6/logs/maplenet_start.log
m_log2=/usr/local/tomcat6/logs/maplenet_stop.log

#
if [ -f $m_pgm ] ; then
   #
   RETVAL=0
   #
   case "$1" in
      #
      start)
         # Run the maplenet_ctl script as user maplenet
         date >> $m_log1
         su - maplenet -c "$m_pgm -x -t -m start" >> $m_log1
      ;;
      #
      stop)
         # Run the maplenet_ctl script as user maplenet
         date >> $m_log2
         su - maplenet -c "$m_pgm -x -t -m stop pass=spiffee" >> $m_log2
      ;;
      #
      *)
         echo "maplenet - unknown option $1"
         echo "Usage: maplenet [start|stop]"
         exit 1
      ;;
   esac
   #
   exit $RETVAL
else
   # Incorrect configuration of this script
   echo "Script $m_pgm is missing."
   exit 1
fi

Directory

Purpose

<webapps>/maplenet

MapleNet root directory. All web pages accessed via the Internet are obtained relative to this directory.

<webapps>/maplenet/admin

administration web pages to set and view the state of MapleNet

<webapps>/maplenet/error

error pages used by JSPs

<webapps>/maplenet/images

images used by the worksheet component and sample applications

<webapps>/maplenet/jar

Java jar files used by all applications

<webapps>/maplenet/js

JavaScript™ files required by the worksheet component and sample applications

<webapps>/maplenet/samples

subdirectories for sample applets, Maplets, JSP and worksheets

<webapps>/maplenet/temp

MapleNet temporary files

<webapps>/maplenet/theme

stylesheets used by the worksheet component and sample applications

<webapps>/maplenet/util

miscellaneous files used internally by MapleNet

<webapps>/maplenet/WEB-INF

standard servlet subdirectory containing directory and files for the operation of MapleNet

kernel.localhost.active=true
kernel.localhost.host=localhost
kernel.localhost.listenport=50574
kernel.localhost.program_path=/usr/local/tomcat/webapps/maplenet/WEB-INF/bin/mserver_shell
kernel.localhost.program_args=-noclient -jgui -z
kernel.localhost.program_ini=ini/maplenet_init
kernel.localhost.minimum=1
kernel.localhost.maximum=20
kernel.localhost.idle=1
kernel.localhost.concurrent=1
kernel.localhost.max_evaluating=1
kernel.localhost.request_timeout=20
kernel.localhost.evaluate_timeout=60
kernel.localhost.lock_timeout=300

Attribute

Description

active

If true, this kernel will be used. If false, the rest of the kernel.<Identifier>.<attribute> entries for this <identifier> are ignored. The only valid values are true and false.

host

The hostname of the computer where Maple resides. Currently, this must be localhost.

listenport

The listening TCP/IP port number used internally by the MapleNet servlet to communicate when starting Maple kernels. Since Maple kernels themselves use ports starting at 50575, this port should be below that. Do not choose a port that would interfere with other software. In most cases, this value should not be changed. Note: This is not the web server (for example, Tomcat) listen port.

program_path

The path to the kernel program. Windows: the path to the mserver.exe file usually found at \Program Files\Maple 18\bin\mserver.exe. Linux: the path to a shell script to start the required kernel found at <webapps>/maplenet/WEB-INF/bin/mserver_shell.

program_args

Arguments required to start the Maple kernel correctly for MapleNet. The -noclient and -jgui arguments are mandatory. The -z argument prevents MapleNet web applications from accessing the local file system and is included to prevent users from compromising server security. Other Maple command line arguments can be added as discussed in Other Settings for Maple Kernel.

program_ini

The relative path to a Maple initialization file that contains settings required for running MapleNet. This path is relative to the <webapps>/maplenet/WEB-INF directory. The default is ini/maplenet_init

minimum

The minimum number of Maple kernels that are continually running. These kernels are started prior to any math requests from MapleNet so that incoming math requests are not delayed by starting Maple. The default is 1.

maximum

The maximum number of Maple kernels allowed to run. This limit should be set to prevent the server from becoming overloaded with too many Maple connections. If maximum kernels are in use, any subsequent request for a new kernel raises an error that is sent back to the MapleNet application.

idle

The surplus of Maple kernels that are started to wait for new math requests as other kernels become busy. Idle kernels are stopped if the number of kernels waiting exceeds the value of idle. This can occur as kernels are released by their math requests.

concurrent

This value is for future use and should be left at 1.

max_evaluating

This value is for future use and should be left at 1.

request_timeout

The time in seconds that a MapleNet application will wait to obtain a Maple kernel from the pool. This timeout generally only occurs if there are maximum Maple kernels in use and a new request for a Maple kernel has to wait for one to become available. The default is 20.

evaluate_timeout

The time in seconds that MapleNet will wait for an individual math calculation to complete in the Maple kernel. This is to prevent cases where the Maple kernel may not return a response in a reasonable amount of time. The default is 60. Note: This differs slightly from prior versions of MapleNet, which had an evaluation timeout for the entire math request as a whole. In fact, a math request could actually contain an array of calculations (that is, multiple Maple expressions). The timeout now applies to each individual expression.

lock_timeout

The time in seconds that a locked Maple kernel can be inactive before being returned to the pool of Maple kernels for reuse. The timeout is measured from the time of the last evaluation performed by the kernel. Locked kernels are tied to a specific user session and are generally released by an application when the application is done. If an application that locks a Maple kernel is inactive for longer than this timeout, that application loses its hold on that kernel and the kernel is returned to the pool. Examples of applications that lock the kernel are Maplets, applets that specifically lock a MapleStatement connection, JSP pages that do not use the <maple:release> tag, and most worksheets. The default is 300 (5 minutes).

K=R+W
if K <MIN then
      c=MIN-K
else
      c=IDL-W
end if
if c>0 then
     if K < MAX then
       create a new kernel
       set its state to idle
       add kernel to the pool
       W=W+1
    end if
else if c < 0 then
     remove oldest idle kernel from pool
     stop kernel process
     W=W-1
end if