org.voovan.http.server

Class HttpModule

java.lang.Object

org.voovan.tools.collection.Attributes

org.voovan.http.server.HttpModule

Direct Known Subclasses:

AnnotationModule, MonitorModule

public abstract class HttpModule
extends Attributes

WebServer的模块

Author:

helyho

Voovan Framework. WebSite: https://github.com/helyho/Voovan Licence: Apache v2 License

Constructor Summary

Constructors

Constructor and Description
HttpModule()

Method Summary

Modifier and Type	Method and Description
void	connect(String routeRegexPath, HttpRouter router) CONNECT 请求
void	delete(String routeRegexPath, HttpRouter router) DELETE 请求
Chain<HttpFilterConfig>	filterChain() 获取过滤器链
void	get(String routeRegexPath, HttpRouter router) GET 请求
HttpModuleConfig	getModuleConfig() 获取HttpModuleConfig
Object	getParamters(String name) 获取模块的配置参数
WebServer	getWebServer() 获取WebServer
void	head(String routeRegexPath, HttpRouter router) HEAD 请求
void	init(WebServer webServer, HttpModuleConfig moduleConfig) 初始化模块操作
abstract void	install() 安装模块至 WebServer
protected void	lifeCycleDestory() 加载并运模块行初始化类
protected void	lifeCycleInit() 加载并运模块行初始化类
void	options(String routeRegexPath, HttpRouter router) OPTIONS 请求
void	otherMethod(String method, String routeRegexPath, HttpRouter router) 其他请求
void	post(String routeRegexPath, HttpRouter router) POST 请求
void	put(String routeRegexPath, HttpRouter router) PUT 请求
void	socket(String routeRegexPath, WebSocketRouter router) WebSocket 服务
void	trace(String routeRegexPath, HttpRouter router) TRACE 请求
abstract void	unInstall() 安装模块至 WebServer

Methods inherited from class org.voovan.tools.collection.Attributes

attributes, clearAttribute, containAttribute, getAttribute, isModifyed, removeAttribute, setAttribute, setModifyed

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpModule

public HttpModule()

Method Detail

getWebServer

public WebServer getWebServer()

获取WebServer

Returns:

WebServer对象

getModuleConfig

public HttpModuleConfig getModuleConfig()

获取HttpModuleConfig

Returns:

HttpModuleConfig对象

init

public void init(WebServer webServer,
                 HttpModuleConfig moduleConfig)

初始化模块操作

Parameters:

webServer - WebServer对象

moduleConfig - 模块配置对象

getParamters

public Object getParamters(String name)

获取模块的配置参数

Parameters:

name - 参数名

Returns:

参数对象

get

public void get(String routeRegexPath,
                HttpRouter router)

GET 请求

Parameters:

routeRegexPath - 匹配路径

router - HTTP处理请求句柄

post

public void post(String routeRegexPath,
                 HttpRouter router)

POST 请求

Parameters:

routeRegexPath - 匹配路径

router - HTTP处理请求句柄

head

public void head(String routeRegexPath,
                 HttpRouter router)

HEAD 请求

Parameters:

routeRegexPath - 匹配路径

router - HTTP处理请求句柄

put

public void put(String routeRegexPath,
                HttpRouter router)

PUT 请求

Parameters:

routeRegexPath - 匹配路径

router - HTTP处理请求句柄

delete

public void delete(String routeRegexPath,
                   HttpRouter router)

DELETE 请求

Parameters:

routeRegexPath - 匹配路径

router - HTTP处理请求句柄

trace

public void trace(String routeRegexPath,
                  HttpRouter router)

TRACE 请求

Parameters:

routeRegexPath - 匹配路径

router - HTTP处理请求句柄

connect

public void connect(String routeRegexPath,
                    HttpRouter router)

CONNECT 请求

Parameters:

routeRegexPath - 匹配路径

router - HTTP处理请求句柄

options

public void options(String routeRegexPath,
                    HttpRouter router)

OPTIONS 请求

Parameters:

routeRegexPath - 匹配路径

router - HTTP处理请求句柄

otherMethod

public void otherMethod(String method,
                        String routeRegexPath,
                        HttpRouter router)

其他请求

Parameters:

method - 请求方法

routeRegexPath - 匹配路径

router - HTTP处理请求句柄

filterChain

public Chain<HttpFilterConfig> filterChain()

获取过滤器链

Returns:

过滤器链

socket

public void socket(String routeRegexPath,
                   WebSocketRouter router)

WebSocket 服务

Parameters:

routeRegexPath - 匹配路径

router - WebSocket处理句柄

lifeCycleInit

protected void lifeCycleInit()

加载并运模块行初始化类

lifeCycleDestory

protected void lifeCycleDestory()

加载并运模块行初始化类

install

public abstract void install()

安装模块至 WebServer

unInstall

public abstract void unInstall()

安装模块至 WebServer