JBoss, a division of Red HatJBoss.org - Community driven.
Printer Friendly Version

CGI How To


The CGI (Common Gateway Interface) defines a way for a web server to interact with external content-generating programs, which are often referred to as CGI programs or CGI scripts.

Within JBoss Web, CGI support can be added when you are using JBoss Web as your HTTP server and require CGI support. Typically this is done during development when you don't want to run a web server like Apache httpd. JBoss Web's CGI support is largely compatible with Apache httpd's, but there are some limitations (e.g., only one cgi-bin directory).

CGI support is implemented using the servlet class org.apache.catalina.servlets.CGIServlet. Traditionally, this servlet is mapped to the URL pattern "/cgi-bin/*".

By default CGI support is disabled in JBoss Web.


CAUTION - CGI scripts are used to execute programs external to the JBoss Web JVM. If you are using the Java SecurityManager this will bypass your security policy configuration in catalina.policy.

Remove the XML comments from around the CGI servlet and servlet-mapping configuration in $CATALINA_BASE/conf/web.xml.


There are several servlet init parameters which can be used to configure the behaviour of the CGI servlet.

  • cgiPathPrefix - The CGI search path will start at the web application root directory + File.separator + this prefix. The default cgiPathPrefix is WEB-INF/cgi
  • debug - Debugging detail level for messages logged by this servlet. Default 0.
  • executable - The of the executable to be used to run the script. Default is perl.
  • parameterEncoding - Name of the parameter encoding to be used with the GCI servlet. Default is System.getProperty("file.encoding","UTF-8").
  • passShellEnvironment - Should the shell environment variables (if any) be passed to the CGI script? Default is false.