| java.lang.Object
 org.apache.turbine.util.TurbineConfig
All known Subclasses: org.apache.turbine.util.TurbineXmlConfig,
| TurbineConfig | | public class TurbineConfig implements ServletConfig,ServletContext,Initializable,Disposable(Code) | | 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.
author:
Quinton McCombs
author:
Rafal Krzewski
author:
Jon S. Stevens
author:
Daniel Rall
author:
Henning P. Schmiedehausen
author:
Eric Pugh
version:
$Id: TurbineConfig.java 534527 2007-05-02 16:10:59Z tv $ |
| Constructor Summary | |
| public | TurbineConfig(String path, Map attributes, Map initParams)
Constructs a new TurbineConfig.
This is the general form of the constructor. | | public | TurbineConfig(String path, Map initParams)
| | public | TurbineConfig(String path, String properties)
Constructs a TurbineConfig.
This is a specialized constructor that allows to configure
Turbine easiliy in the common setups.
Parameters:
path - The web application root (i.e. |
| CONFIGURATION_PATH_KEY | | final public static String CONFIGURATION_PATH_KEY(Code) | | Servlet initialization parameter name for the path to
TurbineConfiguration.xml file used by Turbine
|
| PROPERTIES_PATH_DEFAULT | | final public static String PROPERTIES_PATH_DEFAULT(Code) | | Default value of TurbineResources.properties file path
(/WEB-INF/conf/TurbineResources.properties).
|
| PROPERTIES_PATH_KEY | | final public static String PROPERTIES_PATH_KEY(Code) | | Servlet initialization parameter name for the path to
Turbine.properties file used by Turbine
|
| attributes | | protected Map attributes(Code) | | Servlet container (or emulator) attributes.
|
| initParams | | protected Map initParams(Code) | | Turbine servlet initialization parameters.
|
| root | | protected File root(Code) | | Filenames are looked up in this directory.
|
| TurbineConfig | | public TurbineConfig(String path, Map attributes, Map initParams)(Code) | | Constructs a new TurbineConfig.
This is the general form of the constructor. You can provide
a path to search for files, and a name-value map of init
parameters.
For the list of recognized init parameters, see
org.apache.turbine.Turbine class.
Parameters:
path - The web application root (i.e. the path for file lookup).
Parameters:
attributes - Servlet container (or emulator) attributes.
Parameters:
initParams - initialization parameters. |
| TurbineConfig | | public TurbineConfig(String path, String properties)(Code) | | Constructs a TurbineConfig.
This is a specialized constructor that allows to configure
Turbine easiliy in the common setups.
Parameters:
path - The web application root (i.e. the path for file lookup).
Parameters:
properties - the relative path to TurbineResources.properties file |
| dispose | | public void dispose()(Code) | | Shutdown the Turbine System, lifecycle style
|
| getAttribute | | public Object getAttribute(String s)(Code) | | Returns the servlet container attribute with the given name, or
null if there is no attribute by that name.
|
| getAttributeNames | | public Enumeration getAttributeNames()(Code) | | Returns an Enumeration containing the attribute names available
within this servlet context.
|
| getContext | | public ServletContext getContext(String s)(Code) | | Not implemented.
A method in ServletConfig or ServletContext interface that is not
implemented and will throw UnsuportedOperationException
upon invocation
|
| getInitParameter | | public String getInitParameter(String name)(Code) | | Retrieves an initialization parameter.
Parameters:
name - the name of the parameter. the value of the parameter. |
| getInitParameterNames | | public Enumeration getInitParameterNames()(Code) | | Retrieves an Enumeration of initialization parameter names.
an Enumeration of initialization parameter names. |
| getMajorVersion | | public int getMajorVersion()(Code) | | Not implemented.
A method in ServletConfig or ServletContext interface that is not
implemented and will throw UnsuportedOperationException
upon invocation
|
| getMimeType | | public String getMimeType(String s)(Code) | | Not implemented.
A method in ServletConfig or ServletContext interface that is not
implemented and will throw UnsuportedOperationException
upon invocation
|
| getMinorVersion | | public int getMinorVersion()(Code) | | Not implemented.
A method in ServletConfig or ServletContext interface that is not
implemented and will throw UnsuportedOperationException
upon invocation
|
| getNamedDispatcher | | public RequestDispatcher getNamedDispatcher(String s)(Code) | | Not implemented.
A method in ServletConfig or ServletContext interface that is not
implemented and will throw UnsuportedOperationException
upon invocation
|
| getRealPath | | public String getRealPath(String path)(Code) | | Translates a path relative to the web application root into an
absolute path.
Parameters:
path - A path relative to the web application root. An absolute version of the supplied path, or nullif the translated path doesn't map to a file or directory. |
| getRequestDispatcher | | public RequestDispatcher getRequestDispatcher(String s)(Code) | | Not implemented.
A method in ServletConfig or ServletContext interface that is not
implemented and will throw UnsuportedOperationException
upon invocation
|
| getResource | | public URL getResource(String s) throws MalformedURLException(Code) | | Returns a URL to the resource that is mapped to a specified
path. The path must begin with a "/" and is interpreted
as relative to the current context root.
Parameters:
s - the path to the resource a URL pointing to the resource
exception:
MalformedURLException - |
| getResourceAsStream | | public InputStream getResourceAsStream(String s)(Code) | | Returns the resource located at the named path as
an InputStream object.
Parameters:
s - the path to the resource an InputStream object from which the resource can be read |
| getResourcePaths | | public Set getResourcePaths(String s)(Code) | | Not implemented.
A method in ServletContext (2.3) interface that is not implemented and
will throw UnsuportedOperationException upon invocation
|
| getServerInfo | | public String getServerInfo()(Code) | | Not implemented.
A method in ServletContext (2.3) interface that is not implemented and
will throw UnsuportedOperationException upon invocation
|
| getServlet | | public Servlet getServlet(String s)(Code) | | Not implemented.
A method in ServletContext interface that is not implemented and will
throw UnsuportedOperationException upon invocation
|
| getServletContext | | public ServletContext getServletContext()(Code) | | Returns a reference to the object cast onto ServletContext type.
a ServletContext reference |
| getServletContextName | | public String getServletContextName()(Code) | | Returns the context name.
Fixed value "Turbine" is returned
the context name |
| getServletName | | public String getServletName()(Code) | | Returns the servlet name.
Fixed value "Turbine" is returned.
the servlet name. |
| getServletNames | | public Enumeration getServletNames()(Code) | | Not implemented.
A method in ServletContext interface that is not implemented and will
throw UnsuportedOperationException upon invocation
|
| getServlets | | public Enumeration getServlets()(Code) | | Not implemented.
A method in ServletContext interface that is not implemented and will
throw UnsuportedOperationException upon invocation
|
| init | | public void init(RunData data)(Code) | | Initialization requiring a HTTP GET request.
|
| initialize | | public void initialize()(Code) | | Causes this class to initialize itself which in turn initializes
all of the Turbine Services that need to be initialized.
See Also: org.apache.stratum.lifecycle.Initializable |
| log | | public void log(Exception e, String m)(Code) | | Logs an error message.
Parameters:
e - an Exception.
Parameters:
m - a message. |
| log | | public void log(String m)(Code) | | Logs a message.
Parameters:
m - a message. |
| log | | public void log(String m, Throwable t)(Code) | | Logs an error message.
Parameters:
t - a Throwable object.
Parameters:
m - a message. |
| removeAttribute | | public void removeAttribute(String s)(Code) | | Not implemented.
A method in ServletContext interface that is not implemented and will
throw UnsuportedOperationException upon invocation
|
| setAttribute | | public void setAttribute(String s, Object o)(Code) | | Not implemented.
A method in ServletContext interface that is not implemented and will
throw UnsuportedOperationException upon invocation
|
|
|