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> 负责配置MappingTo。
static interface	WebApiBinder.RenderEngineBindingBuilder 负责配置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.OptionPropertyBindingBuilder<T>, ApiBinder.ScopedBindingBuilder<T>

方法概要

限定符和类型	方法和说明
void	addDiscoverer(BindInfo<? extends MappingDiscoverer> discoverer) 添加 MappingDiscoverer
default void	addDiscoverer(Class<? extends MappingDiscoverer> discoverer) 添加 MappingDiscoverer
default void	addDiscoverer(MappingDiscoverer discoverer) 添加 MappingDiscoverer
default void	addDiscoverer(java.util.function.Supplier<? extends MappingDiscoverer> discoverer) 添加 MappingDiscoverer
void	addMimeType(String type, String mimeType)
default WebApiBinder.RenderEngineBindingBuilder	addRender(String renderName) 添加一个渲染器，用来将 Action 请求的结果渲染成页面。
WebApiBinder.RenderEngineBindingBuilder	addRender(String renderName, String specialMimeType) 添加一个渲染器，用来将 Action 请求的结果渲染成页面。
void	addServletListener(BindInfo<? extends javax.servlet.ServletContextListener> targetRegister) 注册一个ServletContextListener监听器。
default void	addServletListener(Class<? extends javax.servlet.ServletContextListener> targetKey) 注册一个ServletContextListener监听器。
default void	addServletListener(javax.servlet.ServletContextListener sessionListener) 注册一个ServletContextListener监听器。
default void	addServletListener(java.util.function.Supplier<? extends javax.servlet.ServletContextListener> targetProvider) 注册一个ServletContextListener监听器。
void	addSessionListener(BindInfo<? extends javax.servlet.http.HttpSessionListener> targetRegister) 注册一个HttpSessionListener监听器。
default void	addSessionListener(Class<? extends javax.servlet.http.HttpSessionListener> targetKey) 注册一个HttpSessionListener监听器。
default void	addSessionListener(javax.servlet.http.HttpSessionListener sessionListener) 注册一个HttpSessionListener监听器。
default void	addSessionListener(java.util.function.Supplier<? extends javax.servlet.http.HttpSessionListener> targetProvider) 注册一个HttpSessionListener监听器。
WebApiBinder.FilterBindingBuilder<InvokerFilter>	filter(String[] morePatterns) 使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。
default WebApiBinder.FilterBindingBuilder<InvokerFilter>	filter(String urlPattern, String... morePatterns) 使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.FilterBindingBuilder<InvokerFilter>	filterRegex(String[] regexes) 使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。
default 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。
default WebApiBinder.FilterBindingBuilder<javax.servlet.Filter>	jeeFilter(String urlPattern, String... morePatterns) 使用传统表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.FilterBindingBuilder<javax.servlet.Filter>	jeeFilterRegex(String[] regexes) 使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。
default WebApiBinder.FilterBindingBuilder<javax.servlet.Filter>	jeeFilterRegex(String regex, String... regexes) 使用正则表达式，创建一个WebApiBinder.FilterBindingBuilder。
WebApiBinder.ServletBindingBuilder	jeeServlet(String[] morePatterns) 使用 MappingTo 表达式，创建一个WebApiBinder.ServletBindingBuilder。
default WebApiBinder.ServletBindingBuilder	jeeServlet(String urlPattern, String... morePatterns) 使用 MappingTo 表达式，创建一个WebApiBinder.ServletBindingBuilder。
default void	loadMappingTo(Class<?> mabeMappingType) 加载带有 @MappingTo 注解的类。
default void	loadMappingTo(Set<Class<?>> mabeMappingToSet) 加载带有 @MappingTo 注解的类。
default void	loadMappingTo(Set<Class<?>> mabeMappingToSet, java.util.function.Predicate<Class<?>> matcher) 加载带有 @MappingTo 注解的类。
default void	loadMimeType(Charset charset, InputStream inputStream)
default void	loadMimeType(Charset charset, String resource)
default void	loadMimeType(InputStream inputStream)
void	loadMimeType(Reader reader)
default void	loadMimeType(String resource)
default void	loadRender(Class<?> renderClass) 加载 @Render注解配置的渲染器。
default void	loadRender(Set<Class<?>> renderSet) 加载@Render注解配置的渲染器。
default void	loadRender(Set<Class<?>> renderSet, java.util.function.Predicate<Class<?>> matcher) 加载@Render注解配置的渲染器。
<T> WebApiBinder.MappingToBindingBuilder<T>	mappingTo(String[] morePatterns) 使用 MappingTo 表达式，创建一个WebApiBinder.MappingToBindingBuilder。
default <T> WebApiBinder.MappingToBindingBuilder<T>	mappingTo(String urlPattern, String... morePatterns) 使用 MappingTo 表达式，创建一个WebApiBinder.MappingToBindingBuilder。
default WebApiBinder	setEncodingCharacter(String requestEncoding, String responseEncoding) 设置请求响应编码
WebApiBinder	setRequestCharacter(String encoding) 设置请求编码
WebApiBinder	setResponseCharacter(String encoding) 设置响应编码

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

bindInterceptor, bindInterceptor, bindToCreater, bindToCreater, bindToCreater, bindToCreater, 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

default WebApiBinder setEncodingCharacter(String requestEncoding,
                                          String responseEncoding)

设置请求响应编码

getServletVersion

ServletVersion getServletVersion()

获取容器支持的Servlet版本。

jeeServlet

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

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

jeeServlet

WebApiBinder.ServletBindingBuilder jeeServlet(String[] morePatterns)

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

mappingTo

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

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

mappingTo

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

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

loadMappingTo

default void loadMappingTo(Set<Class<?>> mabeMappingToSet)

加载带有 @MappingTo 注解的类。

loadMappingTo

default void loadMappingTo(Set<Class<?>> mabeMappingToSet,
                           java.util.function.Predicate<Class<?>> matcher)

加载带有 @MappingTo 注解的类。

loadMappingTo

default void loadMappingTo(Class<?> mabeMappingType)

加载带有 @MappingTo 注解的类。

filter

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

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

filter

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

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

filterRegex

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

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

filterRegex

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

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

jeeFilter

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

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

jeeFilter

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

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

jeeFilterRegex

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

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

jeeFilterRegex

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

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

addServletListener

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

注册一个ServletContextListener监听器。

addServletListener

default void addServletListener(javax.servlet.ServletContextListener sessionListener)

注册一个ServletContextListener监听器。

addServletListener

default void addServletListener(java.util.function.Supplier<? extends javax.servlet.ServletContextListener> targetProvider)

注册一个ServletContextListener监听器。

addServletListener

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

注册一个ServletContextListener监听器。

addSessionListener

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

注册一个HttpSessionListener监听器。

addSessionListener

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

注册一个HttpSessionListener监听器。

addSessionListener

default void addSessionListener(java.util.function.Supplier<? extends javax.servlet.http.HttpSessionListener> targetProvider)

注册一个HttpSessionListener监听器。

addSessionListener

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

注册一个HttpSessionListener监听器。

addDiscoverer

default void addDiscoverer(Class<? extends MappingDiscoverer> discoverer)

添加 MappingDiscoverer

addDiscoverer

default void addDiscoverer(MappingDiscoverer discoverer)

添加 MappingDiscoverer

addDiscoverer

default void addDiscoverer(java.util.function.Supplier<? extends MappingDiscoverer> discoverer)

添加 MappingDiscoverer

addDiscoverer

void addDiscoverer(BindInfo<? extends MappingDiscoverer> discoverer)

添加 MappingDiscoverer

addMimeType

void addMimeType(String type,
                 String mimeType)

loadMimeType

default void loadMimeType(String resource)
                   throws IOException

抛出:

IOException

loadMimeType

default void loadMimeType(InputStream inputStream)
                   throws IOException

抛出:

IOException

loadMimeType

default void loadMimeType(Charset charset,
                          String resource)
                   throws IOException

抛出:

IOException

loadMimeType

default void loadMimeType(Charset charset,
                          InputStream inputStream)
                   throws IOException

抛出:

IOException

loadMimeType

void loadMimeType(Reader reader)
           throws IOException

抛出:

IOException

loadRender

default void loadRender(Set<Class<?>> renderSet)

加载@Render注解配置的渲染器。

loadRender

default void loadRender(Set<Class<?>> renderSet,
                        java.util.function.Predicate<Class<?>> matcher)

加载@Render注解配置的渲染器。

loadRender

default void loadRender(Class<?> renderClass)

加载 @Render注解配置的渲染器。

addRender

default WebApiBinder.RenderEngineBindingBuilder addRender(String renderName)

添加一个渲染器，用来将 Action 请求的结果渲染成页面。

参数:

renderName - 渲染器名称

addRender

WebApiBinder.RenderEngineBindingBuilder addRender(String renderName,
                                                  String specialMimeType)

添加一个渲染器，用来将 Action 请求的结果渲染成页面。

参数:

renderName - 渲染器名称

specialMimeType - 渲染器使用的 response.ContentType 是什么， 如果没有特殊指定。那么会通过 renderName 在 mime.types.xml 中查找，如果找不到那么不进行特殊设置。