com.jfinal.server.undertow

类 WebBuilder

java.lang.Object

com.jfinal.server.undertow.WebBuilder

public class WebBuilder
extends Object

WebBuilder 用于构建 WebSocket、Filter、Servlet、Listener 缩减 UndertowServer、UndertowConfig 代码，简化配置

字段概要

字段

限定符和类型	字段和说明
protected io.undertow.servlet.api.DeploymentInfo	deploymentInfo
protected UndertowServer	undertowServer
protected WebSocketConfig	webSocketConfig

构造器概要

构造器

构造器和说明
WebBuilder(UndertowServer undertowServer)

方法概要

限定符和类型	方法和说明
WebBuilder	add404ErrorPage(String _404ErrorPage) 配置 404 错误页面
WebBuilder	addErrorPage(io.undertow.servlet.api.ErrorPage errorPage) 配置错误页面，通过继承 ErrorPage 还可以扩展出对错误页面做日志等等功能
WebBuilder	addErrorPage(int errorCode, String errorPage) 配置错误页面
WebBuilder	addFilter(String filterName, String filterClass)
WebBuilder	addFilterInitParam(String filterName, String paraName, String paraValue)
WebBuilder	addFilterUrlMapping(String filterName, String mapping)
WebBuilder	addFilterUrlMapping(String filterName, String mapping, javax.servlet.DispatcherType dispatcherType)
WebBuilder	addInitParameter(String name, String value) 添加初始化参数，对应 web.xml 中的 context-param 例如： shiroEnvironmentClass org.apache.shiro.web.env.IniWebEnvironment
WebBuilder	addListener(String listenerClass)
WebBuilder	addServlet(String servletName, String servletClass)
WebBuilder	addServletInitParam(String servletName, String paraName, String paraValue)
WebBuilder	addServletMapping(String servletName, String mapping)
WebBuilder	addServletMappings(String servletName, String... mappings)
WebBuilder	addWebSocketEndpoint(Class<?> webSocketEndpointClass)
WebBuilder	addWebSocketEndpoint(String webSocketEndpointClass)
WebBuilder	addWelcomePage(String welcomePage) 配置欢迎页面
void	checkServlet(String servletName)
io.undertow.servlet.api.DeploymentInfo	getDeploymentInfo() 通过 getDeploymentInfo() 获取到 DeploymentInfo 对象以后，可以进行更多 web 配置 例如： getDeploymentInfo().addWelcomePage("index.html"); getDeploymentInfo().addErrorPage(new ErrorPage("404.html", 404)); 还可以支持 JSP 配置 例如： UndertowServer .create(DemoConfig.class) .configWeb(wb -> { wb.getDeploymentInfo().addServlet(JspServletBuilder.createServlet("Default Jsp Servlet", "*.jsp")); HashMap tagLibraryInfo = new HashMap<>(); JspServletBuilder.setupDeployment(wb.getDeploymentInfo(), new HashMap(), tagLibraryInfo, new HackInstanceManager()); }) .start();
protected Class<?>	loadClass(String name)
WebBuilder	setServletAsyncSupported(String servletName, boolean asyncSupported)
WebBuilder	setServletLoadOnStartup(String servletName, int loadOnStartup)

从类继承的方法 java.lang.Object

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

字段详细资料

undertowServer

protected UndertowServer undertowServer

deploymentInfo

protected io.undertow.servlet.api.DeploymentInfo deploymentInfo

webSocketConfig

protected WebSocketConfig webSocketConfig

构造器详细资料

WebBuilder

public WebBuilder(UndertowServer undertowServer)

方法详细资料

loadClass

protected Class<?> loadClass(String name)

addFilter

public WebBuilder addFilter(String filterName,
                            String filterClass)

addFilterUrlMapping

public WebBuilder addFilterUrlMapping(String filterName,
                                      String mapping)

addFilterUrlMapping

public WebBuilder addFilterUrlMapping(String filterName,
                                      String mapping,
                                      javax.servlet.DispatcherType dispatcherType)

addFilterInitParam

public WebBuilder addFilterInitParam(String filterName,
                                     String paraName,
                                     String paraValue)

addServlet

public WebBuilder addServlet(String servletName,
                             String servletClass)

checkServlet

public void checkServlet(String servletName)

addServletMapping

public WebBuilder addServletMapping(String servletName,
                                    String mapping)

addServletMappings

public WebBuilder addServletMappings(String servletName,
                                     String... mappings)

addServletInitParam

public WebBuilder addServletInitParam(String servletName,
                                      String paraName,
                                      String paraValue)

setServletAsyncSupported

public WebBuilder setServletAsyncSupported(String servletName,
                                           boolean asyncSupported)

setServletLoadOnStartup

public WebBuilder setServletLoadOnStartup(String servletName,
                                          int loadOnStartup)

addListener

public WebBuilder addListener(String listenerClass)

addWebSocketEndpoint

public WebBuilder addWebSocketEndpoint(String webSocketEndpointClass)

addWebSocketEndpoint

public WebBuilder addWebSocketEndpoint(Class<?> webSocketEndpointClass)

addInitParameter

public WebBuilder addInitParameter(String name,
                                   String value)

添加初始化参数，对应 web.xml 中的 context-param 例如： shiroEnvironmentClass org.apache.shiro.web.env.IniWebEnvironment

addErrorPage

public WebBuilder addErrorPage(io.undertow.servlet.api.ErrorPage errorPage)

配置错误页面，通过继承 ErrorPage 还可以扩展出对错误页面做日志等等功能

addErrorPage

public WebBuilder addErrorPage(int errorCode,
                               String errorPage)

配置错误页面

add404ErrorPage

public WebBuilder add404ErrorPage(String _404ErrorPage)

配置 404 错误页面

addWelcomePage

public WebBuilder addWelcomePage(String welcomePage)

配置欢迎页面

getDeploymentInfo

public io.undertow.servlet.api.DeploymentInfo getDeploymentInfo()

通过 getDeploymentInfo() 获取到 DeploymentInfo 对象以后，可以进行更多 web 配置

   例如：
     getDeploymentInfo().addWelcomePage("index.html");
     getDeploymentInfo().addErrorPage(new ErrorPage("404.html", 404));
 

还可以支持 JSP 配置

   例如：
   UndertowServer
   .create(DemoConfig.class)
   .configWeb(wb -> {
        wb.getDeploymentInfo().addServlet(JspServletBuilder.createServlet("Default Jsp Servlet", "*.jsp"));
        
        HashMap tagLibraryInfo = new HashMap<>();
        JspServletBuilder.setupDeployment(wb.getDeploymentInfo(), new HashMap(),
                                                                         tagLibraryInfo, new HackInstanceManager());
   })
   .start();