|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.turbine.util.TurbineConfig
A class used for initialization of Turbine without a servlet container.
If you need to use Turbine outside of a servlet container, you can use this class for initialization of the Turbine servlet.
TurbineConfig config = new TurbineConfig(".", "conf/TurbineResources.properties");
All paths referenced in TurbineResources.properties and the path to the properties file itself (the second argument) will be resolved relative to the directory given as the first argument of the constructor, here - the directory where application was started. Don't worry about discarding the references to objects created above. They are not needed, once everything is initialized.
In order to initialize the Services Framework outside of the Turbine Servlet,
you need to call the init() method. By default, this will
initialize the Resource and Logging Services and any other services you
have defined in your TurbineResources.properties file.
| Field Summary | |
protected java.util.Map |
attributes
Servlet container (or emulator) attributes. |
static java.lang.String |
CONFIGURATION_PATH_KEY
Servlet initialization parameter name for the path to TurbineConfiguration.xml file used by Turbine |
protected java.util.Map |
initParams
Turbine servlet initialization parameters. |
static java.lang.String |
PROPERTIES_PATH_DEFAULT
Default value of TurbineResources.properties file path ( /WEB-INF/conf/TurbineResources.properties). |
static java.lang.String |
PROPERTIES_PATH_KEY
Servlet initialization parameter name for the path to Turbine.properties file used by Turbine |
protected java.io.File |
root
Filenames are looked up in this directory. |
| Constructor Summary | |
TurbineConfig(java.lang.String path,
java.util.Map initParams)
|
|
TurbineConfig(java.lang.String path,
java.util.Map attributes,
java.util.Map initParams)
Constructs a new TurbineConfig. |
|
TurbineConfig(java.lang.String path,
java.lang.String properties)
Constructs a TurbineConfig. |
|
| Method Summary | |
void |
dispose()
Shutdown the Turbine System, lifecycle style |
java.lang.Object |
getAttribute(java.lang.String s)
Returns the servlet container attribute with the given name, or null if there is no attribute by that name. |
java.util.Enumeration |
getAttributeNames()
Returns an Enumeration containing the attribute names available within this servlet context. |
javax.servlet.ServletContext |
getContext(java.lang.String s)
Not implemented. |
java.lang.String |
getInitParameter(java.lang.String name)
Retrieves an initialization parameter. |
java.util.Enumeration |
getInitParameterNames()
Retrieves an Enumeration of initialization parameter names. |
int |
getMajorVersion()
Not implemented. |
java.lang.String |
getMimeType(java.lang.String s)
Not implemented. |
int |
getMinorVersion()
Not implemented. |
javax.servlet.RequestDispatcher |
getNamedDispatcher(java.lang.String s)
Not implemented. |
java.lang.String |
getRealPath(java.lang.String path)
Translates a path relative to the web application root into an absolute path. |
javax.servlet.RequestDispatcher |
getRequestDispatcher(java.lang.String s)
Not implemented. |
java.net.URL |
getResource(java.lang.String s)
Returns a URL to the resource that is mapped to a specified path. |
java.io.InputStream |
getResourceAsStream(java.lang.String s)
Returns the resource located at the named path as an InputStream object. |
java.util.Set |
getResourcePaths(java.lang.String s)
Not implemented. |
java.lang.String |
getServerInfo()
Not implemented. |
javax.servlet.Servlet |
getServlet(java.lang.String s)
Deprecated. As of Java Servlet API 2.1, with no direct replacement. |
javax.servlet.ServletContext |
getServletContext()
Returns a reference to the object cast onto ServletContext type. |
java.lang.String |
getServletContextName()
Returns the context name. |
java.lang.String |
getServletName()
Returns the servlet name. |
java.util.Enumeration |
getServletNames()
Deprecated. As of Java Servlet API 2.1, with no replacement. |
java.util.Enumeration |
getServlets()
Deprecated. As of Java Servlet API 2.0, with no replacement. |
void |
init(RunData data)
Initialization requiring a HTTP GET request. |
void |
initialize()
Causes this class to initialize itself which in turn initializes all of the Turbine Services that need to be initialized. |
void |
log(java.lang.Exception e,
java.lang.String m)
Deprecated. use log(String,Throwable) instead |
void |
log(java.lang.String m)
Logs a message. |
void |
log(java.lang.String m,
java.lang.Throwable t)
Logs an error message. |
void |
removeAttribute(java.lang.String s)
Not implemented. |
void |
setAttribute(java.lang.String s,
java.lang.Object o)
Not implemented. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final java.lang.String CONFIGURATION_PATH_KEY
public static final java.lang.String PROPERTIES_PATH_KEY
public static final java.lang.String PROPERTIES_PATH_DEFAULT
/WEB-INF/conf/TurbineResources.properties).
protected java.io.File root
protected java.util.Map attributes
protected java.util.Map initParams
| Constructor Detail |
public TurbineConfig(java.lang.String path,
java.util.Map attributes,
java.util.Map initParams)
For the list of recognized init parameters, see
Turbine class.
path - The web application root (i.e. the path for file lookup).attributes - Servlet container (or emulator) attributes.initParams - initialization parameters.
public TurbineConfig(java.lang.String path,
java.util.Map initParams)
TurbineConfig(String path, Map attributes, Map initParams)
public TurbineConfig(java.lang.String path,
java.lang.String properties)
path - The web application root (i.e. the path for file lookup).properties - the relative path to TurbineResources.properties file| Method Detail |
public void initialize()
initialize in interface org.apache.avalon.framework.activity.Initializableorg.apache.stratum.lifecycle.Initializablepublic void init(RunData data)
GET request.
public void dispose()
dispose in interface org.apache.avalon.framework.activity.Disposablepublic javax.servlet.ServletContext getServletContext()
getServletContext in interface javax.servlet.ServletConfigpublic java.lang.String getRealPath(java.lang.String path)
getRealPath in interface javax.servlet.ServletContextpath - A path relative to the web application root.
null
if the translated path doesn't map to a file or directory.public java.lang.String getInitParameter(java.lang.String name)
getInitParameter in interface javax.servlet.ServletConfigname - the name of the parameter.
public java.util.Enumeration getInitParameterNames()
getInitParameterNames in interface javax.servlet.ServletConfigpublic java.lang.String getServletName()
getServletName in interface javax.servlet.ServletConfigpublic java.lang.String getServletContextName()
getServletContextName in interface javax.servlet.ServletContext
public java.net.URL getResource(java.lang.String s)
throws java.net.MalformedURLException
getResource in interface javax.servlet.ServletContexts - the path to the resource
java.net.MalformedURLExceptionpublic java.io.InputStream getResourceAsStream(java.lang.String s)
InputStream object.
getResourceAsStream in interface javax.servlet.ServletContexts - the path to the resource
public void log(java.lang.Exception e,
java.lang.String m)
log in interface javax.servlet.ServletContexte - an Exception.m - a message.public void log(java.lang.String m)
log in interface javax.servlet.ServletContextm - a message.
public void log(java.lang.String m,
java.lang.Throwable t)
log in interface javax.servlet.ServletContextt - a Throwable object.m - a message.public java.lang.Object getAttribute(java.lang.String s)
getAttribute in interface javax.servlet.ServletContextpublic java.util.Enumeration getAttributeNames()
getAttributeNames in interface javax.servlet.ServletContextpublic javax.servlet.ServletContext getContext(java.lang.String s)
UnsuportedOperationException
upon invocation
getContext in interface javax.servlet.ServletContextpublic int getMajorVersion()
UnsuportedOperationException
upon invocation
getMajorVersion in interface javax.servlet.ServletContextpublic java.lang.String getMimeType(java.lang.String s)
UnsuportedOperationException
upon invocation
getMimeType in interface javax.servlet.ServletContextpublic int getMinorVersion()
UnsuportedOperationException
upon invocation
getMinorVersion in interface javax.servlet.ServletContextpublic javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String s)
UnsuportedOperationException
upon invocation
getNamedDispatcher in interface javax.servlet.ServletContextpublic javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String s)
UnsuportedOperationException
upon invocation
getRequestDispatcher in interface javax.servlet.ServletContextpublic java.util.Set getResourcePaths(java.lang.String s)
UnsuportedOperationException upon invocation
getResourcePaths in interface javax.servlet.ServletContextpublic java.lang.String getServerInfo()
UnsuportedOperationException upon invocation
getServerInfo in interface javax.servlet.ServletContextpublic javax.servlet.Servlet getServlet(java.lang.String s)
UnsuportedOperationException upon invocation
getServlet in interface javax.servlet.ServletContextpublic java.util.Enumeration getServletNames()
UnsuportedOperationException upon invocation
getServletNames in interface javax.servlet.ServletContextpublic java.util.Enumeration getServlets()
UnsuportedOperationException upon invocation
getServlets in interface javax.servlet.ServletContextpublic void removeAttribute(java.lang.String s)
UnsuportedOperationException upon invocation
removeAttribute in interface javax.servlet.ServletContext
public void setAttribute(java.lang.String s,
java.lang.Object o)
UnsuportedOperationException upon invocation
setAttribute in interface javax.servlet.ServletContext
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||