org.jboss.web.php

Class ScriptEnvironment

java.lang.Object

org.jboss.web.php.ScriptEnvironment

public class ScriptEnvironment
extends Object

Encapsulates the Script Environment and rules to derive that environment from the servlet container and request information.

Since:

1.0

Version:

$Revision: 1473 $, $Date: 2010-05-17 19:46:58 +0200 (Mon, 17 May 2010) $

Author:

Mladen Turk

Constructor Summary

Constructors

Constructor and Description
ScriptEnvironment(javax.servlet.http.HttpServletRequest req, javax.servlet.ServletContext context, String scriptPathPrefix) Creates a CGIEnvironment and derives the necessary environment, query parameters, working directory, cgi command, etc.

Method Summary

Modifier and Type	Method and Description
protected String	blanksToString(String couldBeBlank, String subForBlanks) Converts blank strings to another string
protected void	expandScript() Extracts requested resource from web app archive to context work directory to enable script to be executed.
protected String[]	findScript(String pathInfo, String webAppRootDir, String contextPath, String servletPath, String scriptPathPrefix) Resolves core information about the php script.
Hashtable	getEnvironment() Gets derived Script environment
String[]	getEnvironmentArray() Converts Environment Hastable to String array
String	getFullPath() Gets derived script full path
ArrayList	getParameters() Gets derived Script query parameters
File	getScriptFile() Gets derived Script file
File	getWorkingDirectory() Gets derived Script working directory
static String[]	hashToStringArray(Hashtable h) Converts a Hashtable to a String array by converting each key/value pair in the Hashtable to two consecutive Strings
boolean	isValid() Gets validity status
protected String	nullsToBlanks(String s) Converts null strings to blank strings ("")
protected String	nullsToString(String couldBeNull, String subForNulls) Converts null strings to another string
protected boolean	setEnvironment(javax.servlet.http.HttpServletRequest req) Constructs the CGI environment to be supplied to the invoked CGI script; relies heavliy on Servlet API methods and findCGI

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptEnvironment

public ScriptEnvironment(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.ServletContext context,
                         String scriptPathPrefix)
                  throws IOException

Creates a CGIEnvironment and derives the necessary environment, query parameters, working directory, cgi command, etc.

Parameters:

req - HttpServletRequest for information provided by the Servlet API

context - ServletContext for information provided by the Servlet API

Throws:

IOException

Method Detail

findScript

protected String[] findScript(String pathInfo,
                              String webAppRootDir,
                              String contextPath,
                              String servletPath,
                              String scriptPathPrefix)

Resolves core information about the php script.

Example URI:

 /servlet/scriptGateway/dir1/realScript/pathinfo1 

• path = $CATALINA_HOME/mywebapp/dir1/realScript
• scriptName = /servlet/scriptGateway/dir1/realScript
• fullName = /dir1/realScript
• name = realScript

Script search algorithm: search the real path below <my-webapp-root> and find the first non-directory in the getPathTranslated("/"), reading/searching from left-to-right.

The Script search path will start at webAppRootDir + File.separator + scriptPathPrefix (or webAppRootDir alone if scriptPathPrefix is null).

scriptPathPrefix is defined by setting this servlet's scriptPathPrefix init parameter

Parameters:

pathInfo - String from HttpServletRequest.getPathInfo()

webAppRootDir - String from context.getRealPath("/")

contextPath - String as from HttpServletRequest.getContextPath()

servletPath - String as from HttpServletRequest.getServletPath()

scriptPathPrefix - Subdirectory of webAppRootDir below which the web app's Scripts may be stored; can be null. The Script search path will start at webAppRootDir + File.separator + scriptPathPrefix (or webAppRootDir alone if scriptPathPrefix is null). scriptPathPrefix is defined by setting the servlet's scriptPathPrefix init parameter.

Returns:

• path - full file-system path to valid script file, or null if no script file was found
• scriptName - Script variable SCRIPT_NAME; the full URL path to valid script file or null if no script was found
• fullName - servlet pathInfo fragment corresponding to the script itself, or null if not found
• name - simple name (no directories) of the script, or null if no script was found

expandScript

protected void expandScript()

Extracts requested resource from web app archive to context work directory to enable script to be executed.

setEnvironment

protected boolean setEnvironment(javax.servlet.http.HttpServletRequest req)
                          throws IOException

Constructs the CGI environment to be supplied to the invoked CGI script; relies heavliy on Servlet API methods and findCGI

Parameters:

req - request associated with the CGI invokation

Returns:

true if environment was set OK, false if there was a problem and no environment was set

Throws:

IOException

getFullPath

public String getFullPath()

Gets derived script full path

Returns:

full script path

getScriptFile

public File getScriptFile()

Gets derived Script file

Returns:

Script file

getWorkingDirectory

public File getWorkingDirectory()

Gets derived Script working directory

Returns:

working directory

getEnvironment

public Hashtable getEnvironment()

Gets derived Script environment

Returns:

Script environment

getParameters

public ArrayList getParameters()

Gets derived Script query parameters

Returns:

Script query parameters

isValid

public boolean isValid()

Gets validity status

Returns:

true if this environment is valid, false otherwise

nullsToBlanks

protected String nullsToBlanks(String s)

Converts null strings to blank strings ("")

Parameters:

s - string to be converted if necessary

Returns:

a non-null string, either the original or the empty string ("") if the original was null

nullsToString

protected String nullsToString(String couldBeNull,
                               String subForNulls)

Converts null strings to another string

Parameters:

couldBeNull - string to be converted if necessary

subForNulls - string to return instead of a null string

Returns:

a non-null string, either the original or the substitute string if the original was null

blanksToString

protected String blanksToString(String couldBeBlank,
                                String subForBlanks)

Converts blank strings to another string

Parameters:

couldBeBlank - string to be converted if necessary

subForBlanks - string to return instead of a blank string

Returns:

a non-null string, either the original or the substitute string if the original was null or empty ("")

getEnvironmentArray

public String[] getEnvironmentArray()
                             throws NullPointerException

Converts Environment Hastable to String array

Returns:

Srring array containing name value pairs.

Throws:

NullPointerException - if a hash key has a null value

hashToStringArray

public static String[] hashToStringArray(Hashtable h)
                                  throws NullPointerException

Converts a Hashtable to a String array by converting each key/value pair in the Hashtable to two consecutive Strings

Parameters:

h - Hashtable to convert

Returns:

converted string array

Throws:

NullPointerException - if a hash key has a null value