org.voovan.http.server.context

Class WebContext

java.lang.Object

org.voovan.http.server.context.WebContext

public class WebContext
extends Object

Web上下文(配置信息读取)

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TOKEN 管理令牌
static String	FULL_VERSION
static boolean	PAUSE 暂停标记
static byte[]	RESPONSE_COMMON_HEADER
static String	SERVER
static String	VERSION

Method Summary

Modifier and Type	Method and Description
static WebServerConfig	buildConfigFromFile(String configFilePath) 从一个配置文件, 获取一个 WebServer 的配置对象
static WebServerConfig	buildConfigFromJSON(String json) 从一个配置字符串, 获取一个 WebServer 的配置对象
static WebServerConfig	buildConfigFromMap(Map<String,Object> configMap) 获取一个 WebServer 的配置对象
static WebServerConfig	buildConfigFromRemote(String httpUrl) 从一个配置字符串, 获取一个 WebServer 的配置对象
static WebServerConfig	buildWebServerConfig() 构造一个新的 WebServer 配置对象
static void	getAuthToken() 获取 AuthToken
static <T> T	getContextParameter(String name, T defaultValue) 取配置中的参数定义
static String	getDefaultErrorPage() 默认错误输出定义
static Map<String,Object>	getErrorDefine() 获取错误输出定义
static Map<String,Object>	getMimeDefine() 获取 mime 定义
static String	getSessionName() 获取在 Cookie 中保存 session id 的名称
static WebServerConfig	getWebServerConfig() 获取WebServer配置对象
static void	initWebServerPluginConfig(boolean isInit)
static boolean	isCache() 是否开启请求缓存机制
static void	loadWebConfig() 读取配置文件
static void	logo()
static void	welcome() 显示欢迎信息
static void	writeAccessLog(WebServerConfig webServerConfig, HttpRequest request, HttpResponse response) 写入access.log

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_TOKEN

public static String AUTH_TOKEN

管理令牌

PAUSE

public static boolean PAUSE

暂停标记

SERVER

public static final String SERVER

FULL_VERSION

public static final String FULL_VERSION

VERSION

public static final String VERSION

RESPONSE_COMMON_HEADER

public static byte[] RESPONSE_COMMON_HEADER

Method Detail

isCache

public static boolean isCache()

是否开启请求缓存机制

Returns:

true 开启

loadWebConfig

public static void loadWebConfig()

读取配置文件

buildConfigFromMap

public static WebServerConfig buildConfigFromMap(Map<String,Object> configMap)

获取一个 WebServer 的配置对象

Parameters:

configMap - 配置对象的 Map

Returns:

WebServerConfig 对象

buildConfigFromFile

public static WebServerConfig buildConfigFromFile(String configFilePath)

从一个配置文件, 获取一个 WebServer 的配置对象

Parameters:

configFilePath - 配置文件

Returns:

WebServerConfig 对象

buildConfigFromJSON

public static WebServerConfig buildConfigFromJSON(String json)

从一个配置字符串, 获取一个 WebServer 的配置对象

Parameters:

json - 配置文件

Returns:

WebServerConfig 对象

buildConfigFromRemote

public static WebServerConfig buildConfigFromRemote(String httpUrl)

从一个配置字符串, 获取一个 WebServer 的配置对象

Parameters:

httpUrl - 配置文件

Returns:

WebServerConfig 对象

initWebServerPluginConfig

public static void initWebServerPluginConfig(boolean isInit)

buildWebServerConfig

public static WebServerConfig buildWebServerConfig()

构造一个新的 WebServer 配置对象

Returns:

WebServer配置对象

getWebServerConfig

public static WebServerConfig getWebServerConfig()

获取WebServer配置对象

Returns:

WebServer配置对象

logo

public static void logo()

welcome

public static void welcome()

显示欢迎信息

getAuthToken

public static void getAuthToken()

获取 AuthToken

writeAccessLog

public static void writeAccessLog(WebServerConfig webServerConfig,
                                  HttpRequest request,
                                  HttpResponse response)

写入access.log

Parameters:

webServerConfig - WebServer 配置对象

request - HTTP 请求对象

response - HTTP 响应对象

getContextParameter

public static <T> T getContextParameter(String name,
                                        T defaultValue)

取配置中的参数定义

Type Parameters:

T - 范型

Parameters:

name - 参数名

defaultValue - 默认值

Returns:

参数定义

getMimeDefine

public static Map<String,Object> getMimeDefine()

获取 mime 定义

Returns:

MIME 定义 Map

getErrorDefine

public static Map<String,Object> getErrorDefine()

获取错误输出定义

Returns:

错误输出定义

getSessionName

public static String getSessionName()

获取在 Cookie 中保存 session id 的名称

Returns:

session id 的名称

getDefaultErrorPage

public static String getDefaultErrorPage()

默认错误输出定义

Returns:

错误输出定义