EL configuration variables

From Resin 3.0

(Difference between revisions)
Jump to: navigation, search
 
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
[[Category:Configuration]]
+
{{Cleanup}} [[Category:Configuration]]
  
−
= Globally Available Variables =
+
Resin configuration can use JSP EL variables in the resin.xml and resin-web.xml.
  
−
{|
+
= EL Variables =
−
!Variable||Meaning
+
−
|-
+
−
||__FILE__||The current configuration file
+
−
|}
+
  
−
= Globally Available Functions =
+
; getenv
 +
: System environment variables
 +
; host
 +
: Information from the virtual host
 +
; java
 +
: Contains JVM variables
 +
; resin
 +
: Contains top-level Resin configuration like ${resin.home}
 +
; system
 +
: Values from the Java System.getProperties
 +
; webApp
 +
: Information about the web-app
 +
; ${__DIR__}
 +
: The directory of the current configuration file.
 +
; ${__FILE__}
 +
: The current configuration file.
  
−
{|
+
== getenv ==
−
!Function||Description
+
−
|-
+
−
||class_exists||True if the specified class exists in the environment
+
−
|-
+
−
||jndi||Looks up a resource in the JNDI environment
+
−
|-
+
−
||jndi_lookup||Synonym for jndi
+
−
|}
+
  
−
= <resin> environment Variables =
+
The ${getenv} variable returns system environment variables.
  
−
{|
+
  <mypkg:MyBean xmlns:mypkg="urn:java:com.mycom.mypkg">
−
!Variable||Description
+
    <myValue>${getenv["MY_VAR"]}</myValue>
−
|-
+
  </mypkg:MyBean>
−
||resin||The Resin variable object (see com.caucho.server.resin.ResinServer$Var)
+
−
|-
+
−
||resinHome||The Resin binary and library home
+
−
|-
+
−
||serverRoot||The root of the deployment/application data (defaults to to resinHome)
+
−
|}
+
  
−
The resin object has the following methods
+
== host ==
  
−
{|
+
The ${host} variable returns virtual host values
−
!Method||Description
+
−
|-
+
−
||id||returns the value of -server on the command line (3.0.15)
+
−
|-
+
−
||home||returns [-resin-home]
+
−
|-
+
−
||root||returns the deployment root directory, [-server-root] (3.0.15)
+
−
|-
+
−
||rootDir||return the deployment root directory (same as resin.root)
+
−
|-
+
−
||isProfessional()||returns true for a valid Resin professional installation
+
−
|}
+
  
−
= <server> environment Variables =
+
; ${host.name}
 +
: The name used for deployment in a hosts/ directory
 +
; ${host.hostName}
 +
: The canonical DNS host name
 +
; ${host.url}
 +
: The URL for the canonical host name
 +
; ${host.regexp[0]}
 +
: For host-regexp matching, the n-th regexp expression
 +
; ${host.root}
 +
: The virtual host's rootDirectory
 +
; ${host.warDirectory}
 +
: The webapps/ directory in the virtual host
  
−
{|
+
== java ==
−
!Variable||Description
+
−
|-
+
−
||server||information about the server environment
+
−
|}
+
  
−
The server variable has a number of fields/methods available (defined in com.caucho.server.resin.ServerController$Var)
+
; ${java.home}
 +
: The [[Path]] to the JDK's home directory
 +
; ${java.properties['user.name']}
 +
: Any System.getProperty("foo") value
 +
; ${java.userName}
 +
: The value of System.getProperty("user.name")
 +
; ${java.version}
 +
: The value of System.getProperty("java.version")
  
−
{|
+
== resin ==
−
!Attribute||Description
+
−
|-
+
−
||id||The value of -server id from the command line
+
−
|-
+
−
||root||Returns the server's data directory, [-server-root] (3.0.15)
+
−
|-
+
−
||rootDir||The server's root directory (same as server.root)
+
−
|}
+
  
−
= <host> environment variables =
+
; ${resin.address}
 +
: The address of the <server> configuration
 +
; ${resin.conf}
 +
: The path to the Resin configuration file
 +
; ${resin.home}
 +
: The Resin installation directory
 +
; ${resin.port}
 +
: The port of the <server> configuration
 +
; ${resin.root}
 +
: The Resin content root directory
 +
; ${resin.serverId}
 +
: The unique server identifier specified by -server id
 +
; ${resin.version}
 +
: The Resin version
 +
; ${resin.versionDate}
 +
: The Resin build date
  
−
{|
+
== system ==
−
!Variable||Description
+
−
|-
+
−
||host||information about the host environment
+
−
|}
+
  
−
{|
+
The Java System.getProperties values, which are set by the -Dfoo=xxx JVM arguments or set by the JVM itself.
−
!Method||Description
+
−
|-
+
−
||root||the host's root directory (3.0.15)
+
−
|-
+
−
||rootDir||the host's root directory (same as host.root)
+
−
|-
+
−
||hostName||the host's canonical name
+
−
|-
+
−
||URL||the host's URL
+
−
|-
+
−
||regexp||any regular expression values for a host-regexp
+
−
|}
+
  
−
= <web-app> environment variables =
 
  
−
{|
+
  <mypkg:MyBean xmlns:mypkg="urn:java:com.mycom.mypkg">
−
!Variable||Description
+
    <myValue>${system["user.name"]}</myValue>
−
|-
+
  </mypkg:MyBean>
−
||webapp||information about the web-app environment
+
−
|}
+
  
−
{|
+
== webApp ==
−
!Method||Description
+
 
−
|-
+
Variables for a deployed web-app
−
||id||the web-app's unique name
+
 
−
|-
+
; ${webApp.id}
−
||name||the name of the war file (minus the .war)
+
: The unique deployment identifier, like production/webapps/default/ROOT
−
|-
+
; ${webApp.name}
−
||root||the root of the web-app's directory
+
: The name used for the war file like ROOT
−
|-
+
; ${webApp.root}
−
||rootDir||the root of the web-app's directory (same as webapp.root)
+
: The root directory for the expanded war
−
|-
+
; ${webApp.contextPath}
−
||contextPath||the web-app's context path
+
: The web-app's context path as returned by ServletRequest
−
|-
+
; ${webApp.regexp[0]}
−
||regexp||any regexp values from a url-regexp
+
: Values for webapp-regexp matches
−
|}
+
; ${webApp.version}
 +
: The webapp version, if any

Latest revision as of 21:17, 1 December 2011

40px-Edit-clear.png This article requires cleanup and may refer to a legacy version of Resin.

Please visit http://www.caucho.com/documentation/ for the most up-to-date documentation.

Resin configuration can use JSP EL variables in the resin.xml and resin-web.xml.

Contents

[edit] EL Variables

getenv
System environment variables
host
Information from the virtual host
java
Contains JVM variables
resin
Contains top-level Resin configuration like ${resin.home}
system
Values from the Java System.getProperties
webApp
Information about the web-app
${__DIR__}
The directory of the current configuration file.
${__FILE__}
The current configuration file.

[edit] getenv

The ${getenv} variable returns system environment variables. 

 <mypkg:MyBean xmlns:mypkg="urn:java:com.mycom.mypkg">
   <myValue>${getenv["MY_VAR"]}</myValue>
 </mypkg:MyBean>

[edit] host

The ${host} variable returns virtual host values

${host.name}
The name used for deployment in a hosts/ directory
${host.hostName}
The canonical DNS host name
${host.url}
The URL for the canonical host name
${host.regexp[0]}
For host-regexp matching, the n-th regexp expression
${host.root}
The virtual host's rootDirectory
${host.warDirectory}
The webapps/ directory in the virtual host

[edit] java

${java.home}
The Path to the JDK's home directory
${java.properties['user.name']}
Any System.getProperty("foo") value
${java.userName}
The value of System.getProperty("user.name")
${java.version}
The value of System.getProperty("java.version")

[edit] resin

${resin.address}
The address of the <server> configuration
${resin.conf}
The path to the Resin configuration file
${resin.home}
The Resin installation directory
${resin.port}
The port of the <server> configuration
${resin.root}
The Resin content root directory
${resin.serverId}
The unique server identifier specified by -server id
${resin.version}
The Resin version
${resin.versionDate}
The Resin build date

[edit] system

The Java System.getProperties values, which are set by the -Dfoo=xxx JVM arguments or set by the JVM itself. 


 <mypkg:MyBean xmlns:mypkg="urn:java:com.mycom.mypkg">
   <myValue>${system["user.name"]}</myValue>
 </mypkg:MyBean>

[edit] webApp

Variables for a deployed web-app

${webApp.id}
The unique deployment identifier, like production/webapps/default/ROOT
${webApp.name}
The name used for the war file like ROOT
${webApp.root}
The root directory for the expanded war
${webApp.contextPath}
The web-app's context path as returned by ServletRequest
${webApp.regexp[0]}
Values for webapp-regexp matches
${webApp.version}
The webapp version, if any
Retrieved from "http://wiki3.caucho.com/index.php?title=EL_configuration_variables&oldid=4218"
Personal tools