org.apache.sling.launchpad.webapp

Class SlingServlet

java.lang.Object

javax.servlet.GenericServlet

org.apache.sling.launchpad.webapp.SlingServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, Notifiable

public class SlingServlet
extends javax.servlet.GenericServlet
implements Notifiable

The SlingServlet is the externally visible Web Application launcher for Sling. Please refer to the full description The Sling Launchpad on the Sling Wiki for a full description of this class.

Logging goes to ServletContext.log methods.

This class goes into the secondary artifact with the classifier webapp to be used as the main servlet to be registered in the servlet container.

See Also:

The Sling Launchpad, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SlingServlet()

Method Summary

Modifier and Type	Method and Description
void	destroy() Stop the Sling framework when the web application is being stopped
String	getServletInfo()
void	init() Launches the SLing framework if the sling.home setting can be derived from the configuration or the SerlvetContext.
void	service(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) If Sling has already been started, the request is forwarded to the started Sling framework.
void	stopped() The framework has been stopped by calling the Bundle.stop() on the system bundle.
void	updated(File updateFile) The framework has been stopped with the intent to be restarted by calling either of the Bundle.update methods on the system bundle.

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SlingServlet

public SlingServlet()

Method Detail

init

public void init()

Launches the SLing framework if the sling.home setting can be derived from the configuration or the SerlvetContext. Otherwise Sling is not started yet and will be started when the first request comes in.

Overrides:

init in class javax.servlet.GenericServlet

getServletInfo

public String getServletInfo()

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

service

public void service(javax.servlet.ServletRequest req,
                    javax.servlet.ServletResponse res)
             throws javax.servlet.ServletException,
                    IOException

If Sling has already been started, the request is forwarded to the started Sling framework. Otherwise the Sling framework is started unless there were too many startup failures.

If the request is not forwarded to Sling, this method returns a 404/NOT FOUND if the startup failure counter has exceeded or 503/SERVICE UNAVAILABLE if the Sling framework is starting up.

If a request causes the framework to start, it is immediately terminated with said response status and framework is started in a separate thread.

Specified by:

service in interface javax.servlet.Servlet

Specified by:

service in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

IOException

destroy

public void destroy()

Stop the Sling framework when the web application is being stopped

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

stopped

public void stopped()

The framework has been stopped by calling the Bundle.stop() on the system bundle. This actually terminates the Sling Standalone application.

Note, that a new request coming in while the web application is still running, will actually cause Sling to restart !

Specified by:

stopped in interface Notifiable

updated

public void updated(File updateFile)

The framework has been stopped with the intent to be restarted by calling either of the Bundle.update methods on the system bundle.

If an InputStream was provided, this has been copied to a temporary file, which will be used in place of the existing launcher jar file.

Specified by:

updated in interface Notifiable

Parameters:

updateFile - The temporary file to replace the existing launcher jar file. If null the existing launcher jar will be used again.