WebServer (Voovan-码云(gitee.com))

java.lang.Object
- org.voovan.http.server.WebServer

```
public class WebServer
extends Object
```
WebServer 对象

Author:

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

Constructor Summary

Constructors
Constructor and Description

WebServer(WebServerConfig config)
构造函数

Constructors
Constructor and Description
`WebServer(WebServerConfig config)` 构造函数

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebServer`	`connect(String routeRegexPath, HttpRouter router)` CONNECT 请求
`WebServer`	`delete(String routeRegexPath, HttpRouter router)` DELETE 请求
`WebServer`	`get(String routeRegexPath, HttpRouter router)` GET 请求
`WebServer`	`getAndPost(String routeRegexPath, HttpRouter router)` 同时注册 GET 和 POST 请求
`HttpDispatcher`	`getHttpDispatcher()`
`Map<String,Map<String,org.voovan.http.server.RouterWrap<HttpRouter>>>`	`getHttpRouters()` 获取 Http 的路由配置
`SocketContext`	`getServerSocket()`
`SessionManager`	`getSessionManager()` 返回 Session 管理器
`WebServerConfig`	`getWebServerConfig()` 获取 Http 服务配置对象
`WebServerLifeCycle`	`getWebServerLifeCycle()`
`WebSocketDispatcher`	`getWebSocketDispatcher()`
`Map<String,org.voovan.http.server.RouterWrap<WebSocketRouter>>`	`getWebSocketRouters()` 获取 WebSocket 的路由配置
`static boolean`	`hasAdminRight(HttpRequest request)` 是否具备管理权限这里控制必须是 127.0.0.1的 ip 地址, 并且需要提供 authToken
`WebServer`	`head(String routeRegexPath, HttpRouter router)` HEAD 请求
`void`	`InitManagerRouter()` 初始化服务管理相关的路由
`void`	`initModule()` 模块安装
`boolean`	`isServing()` 是否处于服务状态
`static void`	`main(String[] args)` 启动 WebServer 服务
`static WebServer`	`newInstance()` 构建新的 WebServer,从配置文件读取配置
`static WebServer`	`newInstance(File configFile)` 构建新的 WebServer,从配置文件中读取配置方便从集中配置中心加载配置
`static WebServer`	`newInstance(int port)` 构建新的 WebServer,指定服务端口
`static WebServer`	`newInstance(String json)` 构建新的 WebServer,从配置JSON中读取配置方便从集中配置中心加载配置
`static WebServer`	`newInstance(String[] args)` 启动服务
`static WebServer`	`newInstance(WebServerConfig config)` 构建新的 WebServer,从配置对象读取配置
`WebServer`	`options(String routeRegexPath, HttpRouter router)` OPTIONS 请求
`WebServer`	`otherMethod(String method, String routeRegexPath, HttpRouter router)` 其他请求
`void`	`pause()` 服务暂停
`WebServer`	`post(String routeRegexPath, HttpRouter router)` POST 请求
`WebServer`	`put(String routeRegexPath, HttpRouter router)` PUT 请求
`void`	`reload(String reloadInfoJson)` 重新读取 WebConfig 的配置
`WebServer`	`serve()` 启动服务阻塞方式启动
`WebServer`	`socket(String routeRegexPath, WebSocketRouter router)` WebSocket 服务
`void`	`stop()` 停止 WebServer
`WebServer`	`syncServe()` 启动服务非阻塞方式启动
`WebServer`	`trace(String routeRegexPath, HttpRouter router)` TRACE 请求
`void`	`unInitModule()` 模块卸载
`void`	`unPause()` 服务恢复

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebServer
```
public WebServer(WebServerConfig config)
```
    构造函数
    
    Parameters:
    
    config - WEB 配对对象异常
- Method Detail
  - getSessionManager
```
public SessionManager getSessionManager()
```
    返回 Session 管理器
    
    Returns:
    
    Session 管理器
  - initModule
```
public void initModule()
```
    模块安装
  - unInitModule
```
public void unInitModule()
```
    模块卸载
  - getWebServerConfig
```
public WebServerConfig getWebServerConfig()
```
    获取 Http 服务配置对象
    
    Returns:
    
    返回 Http 服务配置对象
  - getHttpDispatcher
```
public HttpDispatcher getHttpDispatcher()
```
  - getWebSocketDispatcher
```
public WebSocketDispatcher getWebSocketDispatcher()
```
  - getServerSocket
```
public SocketContext getServerSocket()
```
  - getWebServerLifeCycle
```
public WebServerLifeCycle getWebServerLifeCycle()
```
  - get
```
public WebServer get(String routeRegexPath,
                     HttpRouter router)
```
    GET 请求
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - post
```
public WebServer post(String routeRegexPath,
                      HttpRouter router)
```
    POST 请求
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - getAndPost
```
public WebServer getAndPost(String routeRegexPath,
                            HttpRouter router)
```
    同时注册 GET 和 POST 请求
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - head
```
public WebServer head(String routeRegexPath,
                      HttpRouter router)
```
    HEAD 请求
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - put
```
public WebServer put(String routeRegexPath,
                     HttpRouter router)
```
    PUT 请求
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - delete
```
public WebServer delete(String routeRegexPath,
                        HttpRouter router)
```
    DELETE 请求
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - trace
```
public WebServer trace(String routeRegexPath,
                       HttpRouter router)
```
    TRACE 请求
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - connect
```
public WebServer connect(String routeRegexPath,
                         HttpRouter router)
```
    CONNECT 请求
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - options
```
public WebServer options(String routeRegexPath,
                         HttpRouter router)
```
    OPTIONS 请求
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - otherMethod
```
public WebServer otherMethod(String method,
                             String routeRegexPath,
                             HttpRouter router)
```
    其他请求
    
    Parameters:
    
    method - 请求方法
    
    routeRegexPath - 匹配路径
    
    router - HTTP处理请求句柄
    
    Returns:
    
    WebServer对象
  - socket
```
public WebServer socket(String routeRegexPath,
                        WebSocketRouter router)
```
    WebSocket 服务
    
    Parameters:
    
    routeRegexPath - 匹配路径
    
    router - WebSocket处理句柄
    
    Returns:
    
    WebServer对象
  - newInstance
```
public static WebServer newInstance(WebServerConfig config)
```
    构建新的 WebServer,从配置对象读取配置
    
    Parameters:
    
    config - WebServer配置类
    
    Returns:
    
    WebServer 对象
  - newInstance
```
public static WebServer newInstance(String json)
```
    构建新的 WebServer,从配置JSON中读取配置方便从集中配置中心加载配置
    
    Parameters:
    
    json - WebServer配置JSON
    
    Returns:
    
    WebServer 对象
  - newInstance
```
public static WebServer newInstance(File configFile)
```
    构建新的 WebServer,从配置文件中读取配置方便从集中配置中心加载配置
    
    Parameters:
    
    configFile - WebServer配置文件
    
    Returns:
    
    WebServer 对象
  - newInstance
```
public static WebServer newInstance(int port)
```
    构建新的 WebServer,指定服务端口
    
    Parameters:
    
    port - HTTP 服务的端口号
    
    Returns:
    
    WebServer 对象
  - newInstance
```
public static WebServer newInstance()
```
    构建新的 WebServer,从配置文件读取配置
    
    Returns:
    
    WebServer 对象
  - reload
```
public void reload(String reloadInfoJson)
```
    重新读取 WebConfig 的配置
    
    Parameters:
    
    reloadInfoJson - 重新读取 WebConfig 的配置信息
  - hasAdminRight
```
public static boolean hasAdminRight(HttpRequest request)
```
    是否具备管理权限这里控制必须是 127.0.0.1的 ip 地址, 并且需要提供 authToken
    
    Parameters:
    
    request - http请求对象
    
    Returns:
    
    true: 具备管理权限, false: 不具备管理权限
  - InitManagerRouter
```
public void InitManagerRouter()
```
    初始化服务管理相关的路由
  - serve
```
public WebServer serve()
```
    启动服务阻塞方式启动
    
    Returns:
    
    WebServer 对象
  - syncServe
```
public WebServer syncServe()
```
    启动服务非阻塞方式启动
    
    Returns:
    
    WebServer 对象
  - getHttpRouters
```
public Map<String,Map<String,org.voovan.http.server.RouterWrap<HttpRouter>>> getHttpRouters()
```
    获取 Http 的路由配置
    
    Returns:
    
    路由配置信息
  - getWebSocketRouters
```
public Map<String,org.voovan.http.server.RouterWrap<WebSocketRouter>> getWebSocketRouters()
```
    获取 WebSocket 的路由配置
    
    Returns:
    
    路由配置信息
  - isServing
```
public boolean isServing()
```
    是否处于服务状态
    
    Returns:
    
    true: 处于服务状态, false: 不处于服务状态
  - pause
```
public void pause()
```
    服务暂停
  - unPause
```
public void unPause()
```
    服务恢复
  - main
```
public static void main(String[] args)
```
    启动 WebServer 服务
    
    Parameters:
    
    args - 启动参数
  - newInstance
```
public static WebServer newInstance(String[] args)
```
    启动服务
    
    Parameters:
    
    args - 启动参数
    
    Returns:
    
    WebServer对象
  - stop
```
public void stop()
```
    停止 WebServer

Class WebServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebServer

Method Detail

getSessionManager

initModule

unInitModule

getWebServerConfig

getHttpDispatcher

getWebSocketDispatcher

getServerSocket

getWebServerLifeCycle

get

post

getAndPost

head

put

delete

trace

connect

options

otherMethod

socket

newInstance

newInstance

newInstance

newInstance

newInstance

reload

hasAdminRight

InitManagerRouter

serve

syncServe

getHttpRouters

getWebSocketRouters

isServing

pause

unPause

main

newInstance

stop