net.hasor.web

接口 WebApiBinder

所有超级接口:

ApiBinder, MimeType

所有已知实现类:

InvokerWebApiBinder, WebApiBinderWrap

public interface WebApiBinder
extends ApiBinder, MimeType

提供了注册Servlet和Filter的方法。

版本:

: 2016-12-26

作者:

赵永春 (zyc@hasor.net)

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	WebApiBinder.FilterBindingBuilder<T> 负责配置Filter。
static interface	WebApiBinder.MappingToBindingBuilder<T> 负责配置Servlet。
static interface	WebApiBinder.RenderEngineBindingBuilder<T> 负责配置RenderEngine。
static interface	WebApiBinder.ServletBindingBuilder 负责配置Servlet。

从接口继承的嵌套类/接口 net.hasor.core.ApiBinder

ApiBinder.InjectConstructorBindingBuilder<T>, ApiBinder.InjectPropertyBindingBuilder<T>, ApiBinder.LifeBindingBuilder<T>, ApiBinder.LinkedBindingBuilder<T>, ApiBinder.MetaDataBindingBuilder<T>, ApiBinder.NamedBindingBuilder<T>, ApiBinder.ScopedBindingBuilder<T>

方法概要

限定符和类型	方法和说明
WebApiBinder	addPlugin(BindInfo<? extends WebPlugin> webPlugin) 添加插件
WebApiBinder	addPlugin(Class<? extends WebPlugin> webPlugin) 添加插件
WebApiBinder	addPlugin(Provider<? extends WebPlugin> webPlugin) 添加插件
WebApiBinder	addPlugin(WebPlugin webPlugin) 添加插件
void	addServletListener(BindInfo<? extends javax.servlet.ServletContextListener> targetRegister) 注册一个ServletContextListener监听器。
void	addServletListener(Class<? extends javax.servlet.ServletContextListener> targetKey) 注册一个ServletContextListener监听器。
void	addServletListener(Provider<? extends javax.servlet.ServletContextListener> targetProvider) 注册一个ServletContextListener监听器。
void	addServletListener(javax.servlet.ServletContextListener sessionListener) 注册一个ServletContextListener监听器。
void	addSessionListener(BindInfo<? extends javax.servlet.http.HttpSessionListener> targetRegister) 注册一个HttpSessionListener监听器。
void	addSessionListener(Class<? extends javax.servlet.http.HttpSessionListener> targetKey) 注册一个HttpSessionListener监听器。
void	addSessionListener(javax.servlet.http.HttpSessionListener sessionListener) 注册一个HttpSessionListener监听器。
void	addSessionListener(Provider<? extends javax.servlet.http.HttpSessionListener> targetProvider) 注册一个HttpSessionListener监听器。
WebApiBinder	addSetup(BindInfo<? extends MappingSetup> setup) 添加MappingSetup
WebApiBinder	addSetup(Class<? extends MappingSetup> setup) 添加MappingSetup
WebApiBinder	addSetup(MappingSetup setup) 添加MappingSetup
WebApiBinder	addSetup(Provider<? extends MappingSetup> setup) 添加MappingSetup
WebApiBinder.FilterBindingBuilder<InvokerFilter>	filter(String[] morePatterns) 使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.FilterBindingBuilder<InvokerFilter>	filter(String urlPattern, String... morePatterns) 使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.FilterBindingBuilder<InvokerFilter>	filterRegex(String[] regexes) 使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.FilterBindingBuilder<InvokerFilter>	filterRegex(String regex, String... regexes) 使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。
javax.servlet.ServletContext	getServletContext() 获取ServletContext对象。
ServletVersion	getServletVersion() 获取容器支持的Servlet版本。
WebApiBinder.FilterBindingBuilder<javax.servlet.Filter>	jeeFilter(String[] morePatterns) 使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.FilterBindingBuilder<javax.servlet.Filter>	jeeFilter(String urlPattern, String... morePatterns) 使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.FilterBindingBuilder<javax.servlet.Filter>	jeeFilterRegex(String[] regexes) 使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.FilterBindingBuilder<javax.servlet.Filter>	jeeFilterRegex(String regex, String... regexes) 使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.ServletBindingBuilder	jeeServlet(String[] morePatterns) 使用 MappingTo 表达式，创建一个WebApiBinder.ServletBindingBuilder。
WebApiBinder.ServletBindingBuilder	jeeServlet(String urlPattern, String... morePatterns) 使用 MappingTo 表达式，创建一个WebApiBinder.ServletBindingBuilder。
WebApiBinder.MappingToBindingBuilder<Object>	mappingTo(String[] morePatterns) 使用 MappingTo 表达式，创建一个WebApiBinder.MappingToBindingBuilder。
WebApiBinder.MappingToBindingBuilder<Object>	mappingTo(String urlPattern, String... morePatterns) 使用 MappingTo 表达式，创建一个WebApiBinder.MappingToBindingBuilder。
void	scanAnnoRender() 扫描Render注解配置的渲染器。
void	scanAnnoRender(Matcher<Class<? extends RenderEngine>> matcher, String... packages) 扫描Render注解配置的渲染器。
void	scanAnnoRender(String... packages) 扫描Render注解配置的渲染器。
void	scanMappingTo()
void	scanMappingTo(Matcher<Class<?>> matcher, String... packages)
void	scanMappingTo(String... packages)
WebApiBinder	setEncodingCharacter(String requestEncoding, String responseEncoding) 设置请求响应编码
WebApiBinder	setRequestCharacter(String encoding) 设置请求编码
WebApiBinder	setResponseCharacter(String encoding) 设置响应编码
WebApiBinder.RenderEngineBindingBuilder<RenderEngine>	suffix(String[] morePatterns) 拦截这些后缀的请求，这些请求会被渲染器渲染。
WebApiBinder.RenderEngineBindingBuilder<RenderEngine>	suffix(String urlPattern, String... morePatterns) 拦截这些后缀的请求，这些请求会被渲染器渲染。

从接口继承的方法 net.hasor.core.ApiBinder

bindInterceptor, bindInterceptor, bindType, bindType, bindType, bindType, bindType, bindType, bindType, bindType, findBindingRegister, findBindingRegister, findClass, findClass, getBindInfo, getBindInfo, getEnvironment, installModule, registerScope, registerScope, tryCast

从接口继承的方法 net.hasor.web.MimeType

getMimeType

方法详细资料

getServletContext

javax.servlet.ServletContext getServletContext()

获取ServletContext对象。

setRequestCharacter

WebApiBinder setRequestCharacter(String encoding)

设置请求编码

setResponseCharacter

WebApiBinder setResponseCharacter(String encoding)

设置响应编码

setEncodingCharacter

WebApiBinder setEncodingCharacter(String requestEncoding,
                                  String responseEncoding)

设置请求响应编码

getServletVersion

ServletVersion getServletVersion()

获取容器支持的Servlet版本。

jeeServlet

WebApiBinder.ServletBindingBuilder jeeServlet(String urlPattern,
                                              String... morePatterns)

使用 MappingTo 表达式，创建一个WebApiBinder.ServletBindingBuilder。

jeeServlet

WebApiBinder.ServletBindingBuilder jeeServlet(String[] morePatterns)

使用 MappingTo 表达式，创建一个WebApiBinder.ServletBindingBuilder。

mappingTo

WebApiBinder.MappingToBindingBuilder<Object> mappingTo(String urlPattern,
                                                       String... morePatterns)

使用 MappingTo 表达式，创建一个WebApiBinder.MappingToBindingBuilder。

mappingTo

WebApiBinder.MappingToBindingBuilder<Object> mappingTo(String[] morePatterns)

使用 MappingTo 表达式，创建一个WebApiBinder.MappingToBindingBuilder。

scanMappingTo

void scanMappingTo()

scanMappingTo

void scanMappingTo(String... packages)

scanMappingTo

void scanMappingTo(Matcher<Class<?>> matcher,
                   String... packages)

filter

WebApiBinder.FilterBindingBuilder<InvokerFilter> filter(String urlPattern,
                                                        String... morePatterns)

使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。

filter

WebApiBinder.FilterBindingBuilder<InvokerFilter> filter(String[] morePatterns)

使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。

filterRegex

WebApiBinder.FilterBindingBuilder<InvokerFilter> filterRegex(String regex,
                                                             String... regexes)

使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。

filterRegex

WebApiBinder.FilterBindingBuilder<InvokerFilter> filterRegex(String[] regexes)

使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。

jeeFilter

WebApiBinder.FilterBindingBuilder<javax.servlet.Filter> jeeFilter(String urlPattern,
                                                                  String... morePatterns)

使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。

jeeFilter

WebApiBinder.FilterBindingBuilder<javax.servlet.Filter> jeeFilter(String[] morePatterns)

使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。

jeeFilterRegex

WebApiBinder.FilterBindingBuilder<javax.servlet.Filter> jeeFilterRegex(String regex,
                                                                       String... regexes)

使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。

jeeFilterRegex

WebApiBinder.FilterBindingBuilder<javax.servlet.Filter> jeeFilterRegex(String[] regexes)

使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。

addServletListener

void addServletListener(Class<? extends javax.servlet.ServletContextListener> targetKey)

注册一个ServletContextListener监听器。

addServletListener

void addServletListener(javax.servlet.ServletContextListener sessionListener)

注册一个ServletContextListener监听器。

addServletListener

void addServletListener(Provider<? extends javax.servlet.ServletContextListener> targetProvider)

注册一个ServletContextListener监听器。

addServletListener

void addServletListener(BindInfo<? extends javax.servlet.ServletContextListener> targetRegister)

注册一个ServletContextListener监听器。

addSessionListener

void addSessionListener(Class<? extends javax.servlet.http.HttpSessionListener> targetKey)

注册一个HttpSessionListener监听器。

addSessionListener

void addSessionListener(javax.servlet.http.HttpSessionListener sessionListener)

注册一个HttpSessionListener监听器。

addSessionListener

void addSessionListener(Provider<? extends javax.servlet.http.HttpSessionListener> targetProvider)

注册一个HttpSessionListener监听器。

addSessionListener

void addSessionListener(BindInfo<? extends javax.servlet.http.HttpSessionListener> targetRegister)

注册一个HttpSessionListener监听器。

addPlugin

WebApiBinder addPlugin(Class<? extends WebPlugin> webPlugin)

添加插件

addPlugin

WebApiBinder addPlugin(WebPlugin webPlugin)

添加插件

addPlugin

WebApiBinder addPlugin(Provider<? extends WebPlugin> webPlugin)

添加插件

addPlugin

WebApiBinder addPlugin(BindInfo<? extends WebPlugin> webPlugin)

添加插件

addSetup

WebApiBinder addSetup(Class<? extends MappingSetup> setup)

添加MappingSetup

addSetup

WebApiBinder addSetup(MappingSetup setup)

添加MappingSetup

addSetup

WebApiBinder addSetup(Provider<? extends MappingSetup> setup)

添加MappingSetup

addSetup

WebApiBinder addSetup(BindInfo<? extends MappingSetup> setup)

添加MappingSetup

suffix

WebApiBinder.RenderEngineBindingBuilder<RenderEngine> suffix(String urlPattern,
                                                             String... morePatterns)

拦截这些后缀的请求，这些请求会被渲染器渲染。

suffix

WebApiBinder.RenderEngineBindingBuilder<RenderEngine> suffix(String[] morePatterns)

拦截这些后缀的请求，这些请求会被渲染器渲染。

scanAnnoRender

void scanAnnoRender()

扫描Render注解配置的渲染器。

scanAnnoRender

void scanAnnoRender(String... packages)

扫描Render注解配置的渲染器。

scanAnnoRender

void scanAnnoRender(Matcher<Class<? extends RenderEngine>> matcher,
                    String... packages)

扫描Render注解配置的渲染器。