public class TurbineConfig extends Object implements javax.servlet.ServletConfig, javax.servlet.ServletContext, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.activity.Disposable
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.
TODO Make this class enforce the lifecycle contracts
Modifier and Type | Field and Description |
---|---|
protected Map<String,Object> |
attributes
Servlet container (or emulator) attributes.
|
static String |
CONFIGURATION_PATH_KEY
Servlet initialization parameter name for the path to
TurbineConfiguration.xml file used by Turbine
|
protected Map<String,String> |
initParams
Turbine servlet initialization parameters.
|
static String |
PROPERTIES_PATH_DEFAULT
Default value of TurbineResources.properties file path
(
/WEB-INF/conf/TurbineResources.properties ). |
static String |
PROPERTIES_PATH_KEY
Servlet initialization parameter name for the path to
Turbine.properties file used by Turbine
|
protected File |
root
Filenames are looked up in this directory.
|
Constructor and Description |
---|
TurbineConfig(String path,
Map<String,Object> attributes,
Map<String,String> initParams)
Constructs a new TurbineConfig.
|
TurbineConfig(String path,
Map<String,String> initParams)
Constructs a new TurbineConfig.
|
TurbineConfig(String path,
String properties)
Constructs a TurbineConfig.
|
Modifier and Type | Method and Description |
---|---|
void |
dispose()
Shutdown the Turbine System, lifecycle style
|
Object |
getAttribute(String s)
Returns the servlet container attribute with the given name, or
null if there is no attribute by that name.
|
Enumeration<String> |
getAttributeNames()
Returns an Enumeration containing the attribute names available
within this servlet context.
|
javax.servlet.ServletContext |
getContext(String s)
Not implemented.
|
String |
getContextPath()
Returns the context path.
|
String |
getInitParameter(String name)
Retrieves an initialization parameter.
|
Enumeration<String> |
getInitParameterNames()
Retrieves an Enumeration of initialization parameter names.
|
int |
getMajorVersion()
Not implemented.
|
String |
getMimeType(String s)
Not implemented.
|
int |
getMinorVersion()
Not implemented.
|
javax.servlet.RequestDispatcher |
getNamedDispatcher(String s)
Not implemented.
|
String |
getRealPath(String path)
Translates a path relative to the web application root into an
absolute path.
|
javax.servlet.RequestDispatcher |
getRequestDispatcher(String s)
Not implemented.
|
URL |
getResource(String s)
Returns a URL to the resource that is mapped to a specified
path.
|
InputStream |
getResourceAsStream(String s)
Returns the resource located at the named path as
an
InputStream object. |
Set<String> |
getResourcePaths(String s)
Not implemented.
|
String |
getServerInfo()
Not implemented.
|
javax.servlet.Servlet |
getServlet(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.
|
String |
getServletContextName()
Returns the context name.
|
String |
getServletName()
Returns the servlet name.
|
Enumeration<String> |
getServletNames()
Deprecated.
As of Java Servlet API 2.1, with no replacement.
|
Enumeration<javax.servlet.Servlet> |
getServlets()
Deprecated.
As of Java Servlet API 2.0, with no replacement.
|
Turbine |
getTurbine()
Returns a reference to the Turbine servlet that was initialized.
|
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(Exception e,
String m)
Deprecated.
use log(String,Throwable) instead
|
void |
log(String m)
Logs a message.
|
void |
log(String m,
Throwable t)
Logs an error message.
|
void |
removeAttribute(String s)
Not implemented.
|
void |
setAttribute(String s,
Object o)
Not implemented.
|
public static final String CONFIGURATION_PATH_KEY
public static final String PROPERTIES_PATH_KEY
public static final String PROPERTIES_PATH_DEFAULT
/WEB-INF/conf/TurbineResources.properties
).protected Map<String,Object> attributes
protected Map<String,String> initParams
public TurbineConfig(String path, Map<String,Object> attributes, Map<String,String> 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(String path, Map<String,String> initParams)
For the list of recognized init parameters, see
Turbine
class.
path
- The web application root (i.e. the path for file lookup).initParams
- initialization parameters.public TurbineConfig(String path, String properties)
path
- The web application root (i.e. the path for file lookup).properties
- the relative path to TurbineResources.properties filepublic void initialize()
initialize
in interface org.apache.avalon.framework.activity.Initializable
public void init(RunData data)
GET
request.data
- the Turbine requestpublic void dispose()
dispose
in interface org.apache.avalon.framework.activity.Disposable
public Turbine getTurbine()
public javax.servlet.ServletContext getServletContext()
getServletContext
in interface javax.servlet.ServletConfig
public String getRealPath(String path)
getRealPath
in interface javax.servlet.ServletContext
path
- A path relative to the web application root.null
if the translated path doesn't map to a file or directory.public String getInitParameter(String name)
getInitParameter
in interface javax.servlet.ServletConfig
getInitParameter
in interface javax.servlet.ServletContext
name
- the name of the parameter.public Enumeration<String> getInitParameterNames()
getInitParameterNames
in interface javax.servlet.ServletConfig
getInitParameterNames
in interface javax.servlet.ServletContext
public String getServletName()
getServletName
in interface javax.servlet.ServletConfig
public String getServletContextName()
getServletContextName
in interface javax.servlet.ServletContext
public String getContextPath()
getContextPath
in interface javax.servlet.ServletContext
public URL getResource(String s) throws MalformedURLException
getResource
in interface javax.servlet.ServletContext
s
- the path to the resourceMalformedURLException
public InputStream getResourceAsStream(String s)
InputStream
object.getResourceAsStream
in interface javax.servlet.ServletContext
s
- the path to the resource@Deprecated public void log(Exception e, String m)
log
in interface javax.servlet.ServletContext
e
- an Exception.m
- a message.public void log(String m)
log
in interface javax.servlet.ServletContext
m
- a message.public void log(String m, Throwable t)
log
in interface javax.servlet.ServletContext
t
- a Throwable object.m
- a message.public Object getAttribute(String s)
getAttribute
in interface javax.servlet.ServletContext
public Enumeration<String> getAttributeNames()
getAttributeNames
in interface javax.servlet.ServletContext
public javax.servlet.ServletContext getContext(String s)
UnsuportedOperationException
upon invocationgetContext
in interface javax.servlet.ServletContext
public int getMajorVersion()
UnsuportedOperationException
upon invocationgetMajorVersion
in interface javax.servlet.ServletContext
public String getMimeType(String s)
UnsuportedOperationException
upon invocationgetMimeType
in interface javax.servlet.ServletContext
public int getMinorVersion()
UnsuportedOperationException
upon invocationgetMinorVersion
in interface javax.servlet.ServletContext
public javax.servlet.RequestDispatcher getNamedDispatcher(String s)
UnsuportedOperationException
upon invocationgetNamedDispatcher
in interface javax.servlet.ServletContext
public javax.servlet.RequestDispatcher getRequestDispatcher(String s)
UnsuportedOperationException
upon invocationgetRequestDispatcher
in interface javax.servlet.ServletContext
public Set<String> getResourcePaths(String s)
UnsuportedOperationException
upon invocationgetResourcePaths
in interface javax.servlet.ServletContext
public String getServerInfo()
UnsuportedOperationException
upon invocationgetServerInfo
in interface javax.servlet.ServletContext
@Deprecated public javax.servlet.Servlet getServlet(String s)
UnsuportedOperationException
upon invocationgetServlet
in interface javax.servlet.ServletContext
@Deprecated public Enumeration<String> getServletNames()
UnsuportedOperationException
upon invocationgetServletNames
in interface javax.servlet.ServletContext
@Deprecated public Enumeration<javax.servlet.Servlet> getServlets()
UnsuportedOperationException
upon invocationgetServlets
in interface javax.servlet.ServletContext
public void removeAttribute(String s)
UnsuportedOperationException
upon invocationremoveAttribute
in interface javax.servlet.ServletContext
public void setAttribute(String s, Object o)
UnsuportedOperationException
upon invocationsetAttribute
in interface javax.servlet.ServletContext
Copyright © 2000–2018 The Apache Software Foundation. All rights reserved.