org.apache.sling.engine
Interface SystemStatus

public interface SystemStatus

Provides information on the system status - mostly indicating if the system is ready, or why it is not.

Nested Class Summary

static class

SystemStatus.StatusException

Field Summary

static java.lang.String

STATUS_PATH The SlingMainServlet provides status info if called with this path, and this is also the path under which scripts that define the system status are found.

Method Summary

void	checkSystemReady() Throw an exception if the system is not ready to process requests.
void	clear() Clear any cached state
void	doGet(org.apache.sling.api.SlingHttpServletRequest req, org.apache.sling.api.SlingHttpServletResponse resp) Execute the system readyness checking scripts and copy their output to the response

Field Detail

STATUS_PATH

static final java.lang.String STATUS_PATH

The SlingMainServlet provides status info if called with this path, and this is also the path under which scripts that define the system status are found.

See Also:

Constant Field Values

Method Detail

checkSystemReady

void checkSystemReady()
                      throws java.lang.Exception

Throw an exception if the system is not ready to process requests. The readyness state can be cached, and if it is clear() clears it.

Throws:

java.lang.Exception

clear

void clear()

Clear any cached state

doGet

void doGet(org.apache.sling.api.SlingHttpServletRequest req,
           org.apache.sling.api.SlingHttpServletResponse resp)
           throws java.lang.Exception

Execute the system readyness checking scripts and copy their output to the response

Throws:

java.lang.Exception