SSIServlet (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - org.apache.catalina.ssi.SSIServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig
```
public class SSIServlet
extends HttpServlet
```
Servlet to process SSI requests within a webpage. Mapped to a path from within web.xml.

Author:

Bip Thelin, Amy Roh, Dan Sandberg, David Becker

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowExec` Allow exec (normally blocked for security)
`protected boolean`	`buffered` Should the output be buffered.
`protected int`	`debug` Debug level for this servlet.
`protected Long`	`expires` Expiration time in seconds for the doc.
`protected String`	`inputEncoding` Input encoding.
`protected boolean`	`isVirtualWebappRelative` virtual path can be webapp-relative
`protected String`	`outputEncoding` Output encoding.

Constructor Summary

Constructors
Constructor and Description

SSIServlet()

Constructors
Constructor and Description
`SSIServlet()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`doGet(HttpServletRequest req, HttpServletResponse res)` Process and forward the GET request to our `requestHandler()`*
`void`	`doPost(HttpServletRequest req, HttpServletResponse res)` Process and forward the POST request to our `requestHandler()`.
`void`	`init()` Initialize this servlet.
`protected void`	`processSSI(HttpServletRequest req, HttpServletResponse res, URL resource)`
`protected void`	`requestHandler(HttpServletRequest req, HttpServletResponse res)` Process our request and locate right SSI command.

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet
destroy, 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

- Field Detail
  - debug
```
protected int debug
```
    Debug level for this servlet.
  - buffered
```
protected boolean buffered
```
    Should the output be buffered.
  - expires
```
protected Long expires
```
    Expiration time in seconds for the doc.
  - isVirtualWebappRelative
```
protected boolean isVirtualWebappRelative
```
    virtual path can be webapp-relative
  - inputEncoding
```
protected String inputEncoding
```
    Input encoding. If not specified, uses platform default
  - outputEncoding
```
protected String outputEncoding
```
    Output encoding. If not specified, uses platform default
  - allowExec
```
protected boolean allowExec
```
    Allow exec (normally blocked for security)
- Constructor Detail
  - SSIServlet
```
public SSIServlet()
```
- Method Detail
  - init
```
public void init()
          throws ServletException
```
    Initialize this servlet.
    
    Overrides:
    
    init in class GenericServlet
    
    Throws:
    
    ServletException - if an error occurs
  - doGet
```
public void doGet(HttpServletRequest req,
         HttpServletResponse res)
           throws IOException,
                  ServletException
```
    Process and forward the GET request to our requestHandler()*
    
    Overrides:
    
    doGet in class HttpServlet
    
    Parameters:
    req - a value of type 'HttpServletRequest'
    res - a value of type 'HttpServletResponse'
    
    Throws:
    
    IOException - if an error occurs
    
    ServletException - if an error occurs
    See Also:
    ServletResponse.setContentType(java.lang.String)
  - doPost
```
public void doPost(HttpServletRequest req,
          HttpServletResponse res)
            throws IOException,
                   ServletException
```
    Process and forward the POST request to our requestHandler().
    
    Overrides:
    
    doPost in class HttpServlet
    
    Parameters:
    req - a value of type 'HttpServletRequest'
    res - a value of type 'HttpServletResponse'
    
    Throws:
    
    IOException - if an error occurs
    
    ServletException - if an error occurs
    See Also:
    ServletOutputStream, ServletResponse.setContentType(java.lang.String)
  - requestHandler
```
protected void requestHandler(HttpServletRequest req,
                  HttpServletResponse res)
                       throws IOException
```
    Process our request and locate right SSI command.
    
    Parameters:
    req - a value of type 'HttpServletRequest'
    res - a value of type 'HttpServletResponse'
    
    Throws:
    
    IOException
  - processSSI
```
protected void processSSI(HttpServletRequest req,
              HttpServletResponse res,
              URL resource)
                   throws IOException
```
    Throws:
    
    IOException

Class SSIServlet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Field Detail

debug

buffered

expires

isVirtualWebappRelative

inputEncoding

outputEncoding

allowExec

Constructor Detail

SSIServlet

Method Detail

init

doGet

doPost

requestHandler

processSSI