|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.servlet.GenericServlet org.apache.sling.launchpad.base.webapp.SlingServletDelegate
public class SlingServletDelegate
The SlingServletDelegate
serves as a basic servlet for Project Sling.
The tasks of this servlet are as follows:
init()
method launches Apache Felix
as the
OSGi framework implementation we use.
javax.servlet.Servlet
.
javax.servlet.Servlet
. If no delegatee servlet has been
registered request handlings results in a temporary unavailability of the
servlet.
Request Handling
This servlet handles request by forwarding to a delegatee servlet. The
delegatee servlet is automatically retrieved from the service registry by the
getDelegatee()
. This method also makes sure, the such a servlet
actually exits by throwing an UnvailableException
if not and
also makes sure the servlet is initialized.
Launch Configuration
The Apache Felix
framework requires configuration parameters
to be specified for startup. This servlet builds the list of parameters from
three locations:
sling.properties
is read
from the servlet class path. This properties file contains default settings.loadConfigProperties(String)
method.
After loading all properties, variable substitution takes place on the
property values. A variable is indicated as ${<prop-name>}
where <prop-name>
is the name of a system or
configuration property (configuration properties override system properties).
Variables may be nested and are resolved from inner-most to outer-most. For
example, the property value ${outer-${inner}}
is resolved by
first resolving ${inner}
and then resolving the property whose
name is the catenation of outer-
and the result of resolving
${inner}
.
Logging
This servlet logs through the servlet container logging mechanism by calling
the GenericServlet.log
methods. Bundles launched within the
framework provided by this servlet may use whatever logging mechanism they
choose to use. The Commons OSGI Log Bundle provides an OSGi Log Service
implementation, which also provides access to Apache Commons Logging, SLF4J
and Log4J logging. It is recommended that this bundle is used to setup and
configure logging for systems based on this servlet.
Constructor Summary | |
---|---|
SlingServletDelegate()
|
Method Summary | |
---|---|
void |
destroy()
Destroys this servlet by shutting down the OSGi framework and hence the delegatee servlet if one is set at all. |
void |
init()
Initializes this servlet by loading the framework configuration properties, starting the OSGi framework (Apache Felix) and exposing the system bundle context and the Felix instance as servlet
context attributes. |
void |
service(javax.servlet.ServletRequest req,
javax.servlet.ServletResponse res)
Services the request by delegating to the delegatee servlet. |
void |
setCommandLine(java.util.Map<java.lang.String,java.lang.String> args)
The commandline provided from the standalone launch case. |
void |
setNotifiable(Notifiable notifiable)
The Notifiable to notify on framework stop or update |
void |
setSlingHome(java.lang.String slingHome)
Sets the sling.home to be used for starting the framework. |
boolean |
start()
Starts the framework and returns true if successfull. |
void |
stop()
Stops the framework. |
Methods inherited from class javax.servlet.GenericServlet |
---|
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SlingServletDelegate()
Method Detail |
---|
public void setNotifiable(Notifiable notifiable)
Launcher
Notifiable
to notify on framework stop or update
setNotifiable
in interface Launcher
public void setCommandLine(java.util.Map<java.lang.String,java.lang.String> args)
Launcher
setCommandLine
in interface Launcher
public void setSlingHome(java.lang.String slingHome)
Launcher
null
argument before trying to
start the framework.
setSlingHome
in interface Launcher
public boolean start()
Launcher
true
if successfull.
start
in interface Launcher
public void stop()
Launcher
stop
in interface Launcher
public final void init() throws javax.servlet.ServletException
Felix
instance as servlet
context attributes.
init
in class javax.servlet.GenericServlet
javax.servlet.ServletException
- if the framework cannot be initialized.public final void service(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) throws javax.servlet.ServletException, java.io.IOException
UnavailableException
is
thrown.
service
in interface javax.servlet.Servlet
service
in class javax.servlet.GenericServlet
req
- the ServletRequest
object that contains the
client's requestres
- the ServletResponse
object that will contain
the servlet's response
javax.servlet.UnavailableException
- if the no delegatee servlet is currently
available
javax.servlet.ServletException
- if an exception occurs that interferes with the
servlet's normal operation occurred
java.io.IOException
- if an input or output exception occurspublic final void destroy()
destroy
in interface javax.servlet.Servlet
destroy
in class javax.servlet.GenericServlet
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |