Package com.predic8.membrane.core.interceptor.server

Class WebServerInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.server.WebServerInterceptor

All Implemented Interfaces:

Interceptor

public class WebServerInterceptor
extends AbstractInterceptor

Description

Serves static files based on the request's path.

Explanation

Note that docBase any location: A relative or absolute directory, a "classpath://com.predic8.membrane.core.interceptor.administration.docBase" expression or a URL.

The interceptor chain will not continue beyond this interceptor, as it either successfully returns a HTTP response with the contents of a file, or a "404 Not Found." error.

Topic

4. Interceptors/Features

Nested Class Summary

Nested classes/interfaces inherited from interface com.predic8.membrane.core.interceptor.Interceptor

Interceptor.Flow

Field Summary

Fields inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

name, router

Constructor Summary

Constructors

Constructor	Description
WebServerInterceptor()
WebServerInterceptor(Router r)

Method Summary

Modifier and Type	Method	Description
static Response	createResponse(ResolverMap rr, String resPath)
String	getDocBase()
String	getIndex()
String	getShortDescription()
Outcome	handleRequest(Exchange exc)
void	init()	Called after parsing is complete and this has been added to the object tree (whose root is Router).
boolean	isGenerateIndex()
void	setDocBase(String docBase)
void	setGenerateIndex(boolean generateIndex)
void	setIndex(String i)

Methods inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

getDisplayName, getFlow, getHelpId, getLongDescription, getMessage, getRouter, getRule, handleAbort, handleResponse, init, setDisplayName, setFlow

Methods inherited from class java.lang.Object

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

Constructor Details

WebServerInterceptor

public WebServerInterceptor()

WebServerInterceptor

public WebServerInterceptor(Router r)

Method Details

init

public void init()
          throws Exception

Description copied from class: AbstractInterceptor

Called after parsing is complete and this has been added to the object tree (whose root is Router).

Overrides:

init in class AbstractInterceptor

Throws:

Exception

handleRequest

public Outcome handleRequest(Exchange exc)
                      throws Exception

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

Throws:

Exception

createResponse

public static Response createResponse(ResolverMap rr,
 String resPath)
                               throws IOException

Throws:

IOException

getDocBase

public String getDocBase()

setDocBase

public void setDocBase(String docBase)

Default

docBase

Description

Sets path to the directory that contains the web content.

Example

docBase

getIndex

public String getIndex()

setIndex

public void setIndex(String i)

isGenerateIndex

public boolean isGenerateIndex()

setGenerateIndex

public void setGenerateIndex(boolean generateIndex)

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor