Index

A B C D E F G H I J L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form

A

accept(RoutingContext) - Method in class cool.scx.web.vo.Download

accept(RoutingContext) - Method in class cool.scx.web.vo.Raw

accept(RoutingContext) - Method in class cool.scx.web.vo.Html

accept(RoutingContext) - Method in class cool.scx.web.vo.Image

accept(RoutingContext) - Method in class cool.scx.web.vo.Json

accept(RoutingContext) - Method in class cool.scx.web.vo.Redirection

accept(RoutingContext) - Method in class cool.scx.web.vo.Result

accept(RoutingContext) - Method in class cool.scx.web.vo.Xml

accept(RoutingContext, ScxTemplateHandler) - Method in class cool.scx.web.vo.Template

add(String, Object) - Method in class cool.scx.web.vo.Template

addDirective(BaseTemplateDirective) - Method in class cool.scx.web.template.ScxTemplateHandler

addExceptionHandler(int, ExceptionHandler) - Method in class cool.scx.web.ScxWeb

addExceptionHandler(ExceptionHandler) - Method in class cool.scx.web.ScxWeb

addParameterHandler(int, ParameterHandler) - Method in class cool.scx.web.ScxWeb

addParameterHandler(ParameterHandler) - Method in class cool.scx.web.ScxWeb

addReturnValueHandler(int, ReturnValueHandler) - Method in class cool.scx.web.ScxWeb

addReturnValueHandler(ReturnValueHandler) - Method in class cool.scx.web.ScxWeb

addRoute(WebSocketRoute) - Method in class cool.scx.web.websocket.WebSocketRouter

添加一个路由

B

BadRequestException - Exception Class in cool.scx.web.exception

请求错误异常

BadRequestException() - Constructor for exception class cool.scx.web.exception.BadRequestException

BadRequestException(String) - Constructor for exception class cool.scx.web.exception.BadRequestException

BadRequestException(String, Throwable) - Constructor for exception class cool.scx.web.exception.BadRequestException

BadRequestException(Throwable) - Constructor for exception class cool.scx.web.exception.BadRequestException

BaseTemplateDirective - Interface in cool.scx.web.template

Freemarker 标签父类

BaseVo - Interface in cool.scx.web.vo

BaseVo 接口

BaseVoReturnValueHandler - Class in cool.scx.web.return_value_handler

BaseVo 处理器

BaseVoReturnValueHandler() - Constructor for class cool.scx.web.return_value_handler.BaseVoReturnValueHandler

baseWebSocketHandler() - Method in class cool.scx.web.websocket.WebSocketRoute

baseWebSocketHandler.

BaseWebSocketHandler - Interface in cool.scx.web.websocket

BaseWebSocketHandler 基本接口 请与 ScxWebSocketRoute 配合使用

binaryData() - Method in class cool.scx.web.websocket.OnFrameRoutingContext

bindErrorHandler(Router) - Method in class cool.scx.web.ScxWeb

body - Variable in class cool.scx.web.vo.Result.ResultOfData

body - Variable in class cool.scx.web.vo.Result.ResultOfMap

body() - Method in class cool.scx.web.parameter_handler.RequestInfo

body() - Method in class cool.scx.web.vo.Result

body() - Method in class cool.scx.web.vo.Result.ResultOfData

body() - Method in class cool.scx.web.vo.Result.ResultOfMap

Body(String, T) - Constructor for record class cool.scx.web.vo.Result.Body

Creates an instance of a Body record class.

bytes - Variable in class cool.scx.web.vo.Download

字节数组

bytes - Variable in class cool.scx.web.vo.Raw

字节数组

C

canHandle(ParameterInfo) - Method in class cool.scx.web.parameter_handler.FileUploadParameterHandler

canHandle(ParameterInfo) - Method in class cool.scx.web.parameter_handler.FromBodyParameterHandler

canHandle(ParameterInfo) - Method in class cool.scx.web.parameter_handler.FromPathParameterHandler

canHandle(ParameterInfo) - Method in class cool.scx.web.parameter_handler.FromQueryParameterHandler

canHandle(ParameterInfo) - Method in class cool.scx.web.parameter_handler.LastParameterHandler

canHandle(ParameterInfo) - Method in interface cool.scx.web.parameter_handler.ParameterHandler

判断是否可以处理这个参数类型

canHandle(ParameterInfo) - Method in class cool.scx.web.parameter_handler.RoutingContextParameterHandler

canHandle(Object) - Method in class cool.scx.web.return_value_handler.BaseVoReturnValueHandler

canHandle(Object) - Method in class cool.scx.web.return_value_handler.LastReturnValueHandler

canHandle(Object) - Method in class cool.scx.web.return_value_handler.NullReturnValueHandler

canHandle(Object) - Method in interface cool.scx.web.return_value_handler.ReturnValueHandler

是否能够处理

canHandle(Object) - Method in class cool.scx.web.return_value_handler.StringReturnValueHandler

canHandle(Object) - Method in class cool.scx.web.return_value_handler.TemplateReturnValueHandler

canHandle(Throwable) - Method in interface cool.scx.web.exception_handler.ExceptionHandler

判断是否可以处理这个异常

canHandle(Throwable) - Method in class cool.scx.web.exception_handler.LastExceptionHandler

canHandle(Throwable) - Method in class cool.scx.web.exception_handler.ScxHttpExceptionHandler

cause() - Method in class cool.scx.web.websocket.OnExceptionRoutingContext

clazz - Variable in class cool.scx.web.ScxRouteHandler

clazz 对象

consumes - Variable in class cool.scx.web.ScxRouteHandler

consumes() - Element in annotation interface cool.scx.web.annotation.ScxRoute

contentDisposition - Variable in class cool.scx.web.vo.Download

a

contentDisposition - Variable in class cool.scx.web.vo.Raw

a

contentType - Variable in class cool.scx.web.vo.Download

a

contentType - Variable in class cool.scx.web.vo.Raw

a

contentType() - Method in class cool.scx.web.parameter_handler.RequestInfo

cool.scx.web - package cool.scx.web

cool.scx.web._hack - package cool.scx.web._hack

cool.scx.web.annotation - package cool.scx.web.annotation

cool.scx.web.exception - package cool.scx.web.exception

cool.scx.web.exception_handler - package cool.scx.web.exception_handler

cool.scx.web.interceptor - package cool.scx.web.interceptor

cool.scx.web.parameter_handler - package cool.scx.web.parameter_handler

cool.scx.web.parameter_handler.exception - package cool.scx.web.parameter_handler.exception

cool.scx.web.return_value_handler - package cool.scx.web.return_value_handler

cool.scx.web.template - package cool.scx.web.template

cool.scx.web.vo - package cool.scx.web.vo

cool.scx.web.websocket - package cool.scx.web.websocket

createWebSocketRoute(BaseWebSocketHandler) - Static method in class cool.scx.web.WebSocketRouteRegistrar

D

data() - Method in record class cool.scx.web.vo.Result.Body

Returns the value of the data record component.

DefaultInterceptor - Class in cool.scx.web.interceptor

默认的拦截器实现

DefaultInterceptor() - Constructor for class cool.scx.web.interceptor.DefaultInterceptor

directiveName() - Method in interface cool.scx.web.template.BaseTemplateDirective

获取自定义指令的名称

Download - Class in cool.scx.web.vo

文件下载 vo

E

equals(Object) - Method in record class cool.scx.web.vo.Result.Body

Indicates whether some other object is "equal to" this one.

ExceptionHandler - Interface in cool.scx.web.exception_handler

路由异常处理器

execute(Environment, Map, TemplateModel[], TemplateDirectiveBody) - Method in interface cool.scx.web.template.BaseTemplateDirective

F

fail() - Static method in class cool.scx.web.vo.Result

操作失败

fail(String) - Static method in class cool.scx.web.vo.Result

返回操作失败的 Json 带有消息

fail(String, Object) - Static method in class cool.scx.web.vo.Result

返回操作失败的 Json 带有消息

FileUploadParameterHandler - Class in cool.scx.web.parameter_handler

处理 FileUpload 类型参数

FileUploadParameterHandler() - Constructor for class cool.scx.web.parameter_handler.FileUploadParameterHandler

fillContentType(HttpServerResponse, MediaType) - Static method in class cool.scx.web.ScxWebHelper

fillHtmlContentType(HttpServerResponse) - Static method in class cool.scx.web.ScxWebHelper

fillJsonContentType(HttpServerResponse) - Static method in class cool.scx.web.ScxWebHelper

fillTextPlainContentType(HttpServerResponse) - Static method in class cool.scx.web.ScxWebHelper

fillXmlContentType(HttpServerResponse) - Static method in class cool.scx.web.ScxWebHelper

filterClass(List<Class<?>>) - Static method in class cool.scx.web.RouteRegistrar

filterClass(List<Class<?>>) - Static method in class cool.scx.web.WebSocketRouteRegistrar

filterObject(Object...) - Static method in class cool.scx.web.WebSocketRouteRegistrar

findScxRoute(MethodInfo) - Static method in class cool.scx.web.RouteRegistrar

findScxRouteOrThrow(MethodInfo) - Static method in class cool.scx.web.RouteRegistrar

ForbiddenException - Exception Class in cool.scx.web.exception

登录了但是没权限

ForbiddenException() - Constructor for exception class cool.scx.web.exception.ForbiddenException

ForbiddenException(String) - Constructor for exception class cool.scx.web.exception.ForbiddenException

ForbiddenException(String, Throwable) - Constructor for exception class cool.scx.web.exception.ForbiddenException

ForbiddenException(Throwable) - Constructor for exception class cool.scx.web.exception.ForbiddenException

FORM - Enum constant in enum class cool.scx.web.parameter_handler.RequestInfo.ContentType

formatMapParams(Map<?, ?>) - Static method in interface cool.scx.web.template.BaseTemplateDirective

格式化参数

frame() - Method in class cool.scx.web.websocket.OnFrameRoutingContext

FromBody - Annotation Interface in cool.scx.web.annotation

从 body 获取参数

FromBodyParameterHandler - Class in cool.scx.web.parameter_handler

FromBodyParameterHandler

FromBodyParameterHandler() - Constructor for class cool.scx.web.parameter_handler.FromBodyParameterHandler

FromPath - Annotation Interface in cool.scx.web.annotation

从路径 (Path) 参数

FromPathParameterHandler - Class in cool.scx.web.parameter_handler

FromPathParameterHandler

FromPathParameterHandler() - Constructor for class cool.scx.web.parameter_handler.FromPathParameterHandler

FromQuery - Annotation Interface in cool.scx.web.annotation

从 query 获取参数

FromQueryParameterHandler - Class in cool.scx.web.parameter_handler

FromQueryParameterHandler

FromQueryParameterHandler() - Constructor for class cool.scx.web.parameter_handler.FromQueryParameterHandler

FromUpload - Annotation Interface in cool.scx.web.annotation

从上传中获取参数 (注意 : 必须标注在 FileUpload 类型的参数上)

G

get(String) - Method in class cool.scx.web.vo.Result.ResultOfMap

getFile(String, RoutingContext) - Method in class cool.scx.web._hack.SendFileHelper

getFile(String, RoutingContext) - Method in class cool.scx.web._hack.StaticHandlerImpl

getFromJsonNode(String, JsonNode, boolean) - Static method in class cool.scx.web.ScxWebHelper

getFromJsonNode.

getFromMap(String, MultiMap, boolean, JavaType) - Static method in class cool.scx.web.ScxWebHelper

getFromMap.

getFromMap(String, Map<String, String>, boolean) - Static method in class cool.scx.web.ScxWebHelper

getFromMap.

getRoutes() - Method in class cool.scx.web.websocket.WebSocketRouter

a

getTemplate(String) - Method in class cool.scx.web.template.ScxTemplateHandler

getValueFromBody(String, boolean, boolean, JavaType, RequestInfo) - Static method in class cool.scx.web.parameter_handler.FromBodyParameterHandler

getValueFromPath(String, boolean, boolean, JavaType, RequestInfo) - Static method in class cool.scx.web.parameter_handler.FromPathParameterHandler

getValueFromQuery(String, boolean, boolean, JavaType, RequestInfo) - Static method in class cool.scx.web.parameter_handler.FromQueryParameterHandler

H

handle(ParameterInfo, RequestInfo) - Method in class cool.scx.web.parameter_handler.FileUploadParameterHandler

handle(ParameterInfo, RequestInfo) - Method in class cool.scx.web.parameter_handler.FromBodyParameterHandler

handle(ParameterInfo, RequestInfo) - Method in class cool.scx.web.parameter_handler.FromPathParameterHandler

handle(ParameterInfo, RequestInfo) - Method in class cool.scx.web.parameter_handler.FromQueryParameterHandler

handle(ParameterInfo, RequestInfo) - Method in class cool.scx.web.parameter_handler.LastParameterHandler

handle(ParameterInfo, RequestInfo) - Method in interface cool.scx.web.parameter_handler.ParameterHandler

将结果处理并返回

handle(ParameterInfo, RequestInfo) - Method in class cool.scx.web.parameter_handler.RoutingContextParameterHandler

handle(WebSocketRoute) - Method in class cool.scx.web.websocket.OnCloseRoutingContext

handle(WebSocketRoute) - Method in class cool.scx.web.websocket.OnExceptionRoutingContext

handle(WebSocketRoute) - Method in class cool.scx.web.websocket.OnFrameRoutingContext

handle(WebSocketRoute) - Method in class cool.scx.web.websocket.OnOpenRoutingContext

handle(ServerWebSocket) - Method in class cool.scx.web.websocket.WebSocketRouter

handle(RoutingContext) - Method in class cool.scx.web._hack.StaticHandlerImpl

handle(RoutingContext) - Method in class cool.scx.web.ScxRouteHandler

handle(Object, RoutingContext) - Method in class cool.scx.web.return_value_handler.BaseVoReturnValueHandler

handle(Object, RoutingContext) - Method in class cool.scx.web.return_value_handler.LastReturnValueHandler

handle(Object, RoutingContext) - Method in class cool.scx.web.return_value_handler.NullReturnValueHandler

handle(Object, RoutingContext) - Method in interface cool.scx.web.return_value_handler.ReturnValueHandler

处理结果

handle(Object, RoutingContext) - Method in class cool.scx.web.return_value_handler.StringReturnValueHandler

handle(Object, RoutingContext) - Method in class cool.scx.web.return_value_handler.TemplateReturnValueHandler

handle(Throwable, RoutingContext) - Method in interface cool.scx.web.exception_handler.ExceptionHandler

将结果处理并返回

handle(Throwable, RoutingContext) - Method in class cool.scx.web.exception_handler.LastExceptionHandler

handle(Throwable, RoutingContext) - Method in class cool.scx.web.exception_handler.ScxHttpExceptionHandler

handle(Map<String, Object>) - Method in interface cool.scx.web.template.BaseTemplateDirective

委派下去让子类实现，并且返回加工后的返回值 可返回业务对象，或者集合

handleScxHttpException(ScxHttpException, RoutingContext) - Method in class cool.scx.web.exception_handler.ScxHttpExceptionHandler

hashCode() - Method in record class cool.scx.web.vo.Result.Body

Returns a hash code value for this object.

Html - Class in cool.scx.web.vo

html 渲染类

httpMethods - Variable in class cool.scx.web.ScxRouteHandler

httpMethods 由 注解上的 method 属性转换而来 并采用 set 进行去重

I

ignoreParentUrl() - Element in annotation interface cool.scx.web.annotation.ScxRoute

是否忽略类级别上的 ScxRoute 注解所定义的顶级 url

Image - Class in cool.scx.web.vo

Image class.

Image(File) - Constructor for class cool.scx.web.vo.Image

用来校验 file 是否可用

imageHandler(RoutingContext) - Method in class cool.scx.web.vo.Image

initBody(RoutingContext, RequestInfo.ContentType) - Static method in class cool.scx.web.parameter_handler.RequestInfo

根据不同的 ContentType 以不同的逻辑初始化 body

initContentType(RoutingContext) - Static method in class cool.scx.web.parameter_handler.RequestInfo

inputStream - Variable in class cool.scx.web.vo.Download

输入流

inputStream - Variable in class cool.scx.web.vo.Raw

输入流

instance - Variable in class cool.scx.web.ScxRouteHandler

实例

Interceptor - Interface in cool.scx.web.interceptor

拦截器

InternalServerErrorException - Exception Class in cool.scx.web.exception

服务器内部异常

InternalServerErrorException() - Constructor for exception class cool.scx.web.exception.InternalServerErrorException

InternalServerErrorException(String) - Constructor for exception class cool.scx.web.exception.InternalServerErrorException

InternalServerErrorException(String, Throwable) - Constructor for exception class cool.scx.web.exception.InternalServerErrorException

InternalServerErrorException(Throwable) - Constructor for exception class cool.scx.web.exception.InternalServerErrorException

isRoute(MethodInfo) - Static method in class cool.scx.web.RouteRegistrar

判断是否为 ScxMapping 方法

isRoute(Class<?>) - Static method in class cool.scx.web.RouteRegistrar

初始化 ScxMappingClassList

isVoid - Variable in class cool.scx.web.ScxRouteHandler

返回值类型为空

isWebSocketRouteClass(Class<?>) - Static method in class cool.scx.web.WebSocketRouteRegistrar

iter - Variable in class cool.scx.web.websocket.WebSocketRoutingContext

J

Json - Class in cool.scx.web.vo

Json 格式的返回值

JSON - Enum constant in enum class cool.scx.web.parameter_handler.RequestInfo.ContentType

L

LastExceptionHandler - Class in cool.scx.web.exception_handler

LastExceptionHandler(boolean) - Constructor for class cool.scx.web.exception_handler.LastExceptionHandler

LastParameterHandler - Class in cool.scx.web.parameter_handler

LastParameterHandler

LastParameterHandler() - Constructor for class cool.scx.web.parameter_handler.LastParameterHandler

LastReturnValueHandler - Class in cool.scx.web.return_value_handler

最后的 返回值处理器

LastReturnValueHandler() - Constructor for class cool.scx.web.return_value_handler.LastReturnValueHandler

M

matches(ServerWebSocket) - Method in class cool.scx.web.websocket.WebSocketRoute

a

merge() - Element in annotation interface cool.scx.web.annotation.FromPath

聚合参数

merge() - Element in annotation interface cool.scx.web.annotation.FromQuery

将 查询参数聚合

message() - Method in record class cool.scx.web.vo.Result.Body

Returns the value of the message record component.

method - Variable in class cool.scx.web.ScxRouteHandler

方法

MethodNotAllowedException - Exception Class in cool.scx.web.exception

方法不被允许

MethodNotAllowedException() - Constructor for exception class cool.scx.web.exception.MethodNotAllowedException

MethodNotAllowedException(String) - Constructor for exception class cool.scx.web.exception.MethodNotAllowedException

MethodNotAllowedException(String, Throwable) - Constructor for exception class cool.scx.web.exception.MethodNotAllowedException

MethodNotAllowedException(Throwable) - Constructor for exception class cool.scx.web.exception.MethodNotAllowedException

methods() - Element in annotation interface cool.scx.web.annotation.ScxRoute

N

next() - Method in class cool.scx.web.websocket.WebSocketRoutingContext

NoScxRoute - Annotation Interface in cool.scx.web.annotation

禁用路由注解

NotFoundException - Exception Class in cool.scx.web.exception

404 not found 未找到异常

NotFoundException() - Constructor for exception class cool.scx.web.exception.NotFoundException

NotFoundException(String) - Constructor for exception class cool.scx.web.exception.NotFoundException

NotFoundException(String, Throwable) - Constructor for exception class cool.scx.web.exception.NotFoundException

NotFoundException(Throwable) - Constructor for exception class cool.scx.web.exception.NotFoundException

NULL - Enum constant in enum class cool.scx.web.parameter_handler.RequestInfo.ContentType

NullReturnValueHandler - Class in cool.scx.web.return_value_handler

空值处理器

NullReturnValueHandler() - Constructor for class cool.scx.web.return_value_handler.NullReturnValueHandler

O

of(byte[], FileFormat) - Static method in class cool.scx.web.vo.Raw

of(byte[], String) - Static method in class cool.scx.web.vo.Download

of(File) - Static method in class cool.scx.web.vo.Image

of(File, Integer, Integer, Position) - Static method in class cool.scx.web.vo.Image

of(InputStream, FileFormat) - Static method in class cool.scx.web.vo.Raw

of(InputStream, String) - Static method in class cool.scx.web.vo.Download

of(Object) - Static method in class cool.scx.web.vo.Json

of(Object) - Static method in class cool.scx.web.vo.Xml

of(String) - Static method in class cool.scx.web.vo.Html

of(String) - Static method in class cool.scx.web.vo.Result

of(String) - Static method in class cool.scx.web.vo.Template

of(String, Object) - Static method in class cool.scx.web.vo.Result

of(Path) - Static method in class cool.scx.web.vo.Download

of(Path) - Static method in class cool.scx.web.vo.Html

of(Path) - Static method in class cool.scx.web.vo.Raw

of(Path, String) - Static method in class cool.scx.web.vo.Download

ofPermanent(String) - Static method in class cool.scx.web.vo.Redirection

永久重定向

ofTemporary(String) - Static method in class cool.scx.web.vo.Redirection

临时重定向

ok() - Static method in class cool.scx.web.vo.Result

操作成功

ok(Object) - Static method in class cool.scx.web.vo.Result

onBinaryMessage(OnFrameRoutingContext) - Method in interface cool.scx.web.websocket.BaseWebSocketHandler

发送 二进制数据 时

onClose(OnCloseRoutingContext) - Method in interface cool.scx.web.websocket.BaseWebSocketHandler

连接 关闭 时

OnCloseRoutingContext - Class in cool.scx.web.websocket

OnCloseRoutingContext class.

onError(OnExceptionRoutingContext) - Method in interface cool.scx.web.websocket.BaseWebSocketHandler

连接 错误 时

OnExceptionRoutingContext - Class in cool.scx.web.websocket

OnExceptionRoutingContext class.

OnFrameRoutingContext - Class in cool.scx.web.websocket

OnFrameRoutingContext class.

onOpen(OnOpenRoutingContext) - Method in interface cool.scx.web.websocket.BaseWebSocketHandler

连接 打开 时

OnOpenRoutingContext - Class in cool.scx.web.websocket

OnOpenRoutingContext class.

onTextMessage(OnFrameRoutingContext) - Method in interface cool.scx.web.websocket.BaseWebSocketHandler

发送 文本数据 时

order() - Element in annotation interface cool.scx.web.annotation.ScxRoute

排序

order() - Element in annotation interface cool.scx.web.annotation.ScxWebSocketRoute

排序

order() - Method in class cool.scx.web.ScxRouteHandler

order() - Method in class cool.scx.web.websocket.WebSocketRoute

order.

originalUrl - Variable in class cool.scx.web.ScxRouteHandler

原始的 url 处理规则为 {类注解值}/{方法注解值} 并采取简单的去除重复 "/"

OTHER - Enum constant in enum class cool.scx.web.parameter_handler.RequestInfo.ContentType

P

ParamConvertException - Exception Class in cool.scx.web.parameter_handler.exception

参数转换异常

ParamConvertException(String) - Constructor for exception class cool.scx.web.parameter_handler.exception.ParamConvertException

ParameterHandler - Interface in cool.scx.web.parameter_handler

参数处理器

path - Variable in class cool.scx.web.vo.Download

路径

path - Variable in class cool.scx.web.vo.Raw

路径

path() - Method in class cool.scx.web.websocket.WebSocketRoute

path.

postHandle(RoutingContext, ScxRouteHandler, Object) - Method in interface cool.scx.web.interceptor.Interceptor

注意 : 若处理器中的方法 返回值为 void (即无返回值) 此拦截器则不会执行 后置处理器 在 ScxMappingHandler 所对应的方法执行完成之后 但是并没有将结果响应回客户端之前调用 可再次对响应的数据进行修改

preHandle(RoutingContext, ScxRouteHandler) - Method in interface cool.scx.web.interceptor.Interceptor

前置处理器 在 ScxMappingHandler 所对应的方法执行前调用 用来进行权限验证等操作 若要中断执行请在 handler 中抛出异常 ,异常会有 ScxMappingHandler 的异常处理器进行处理

produces - Variable in class cool.scx.web.ScxRouteHandler

produces() - Element in annotation interface cool.scx.web.annotation.ScxRoute

put(String, Object) - Method in class cool.scx.web.vo.Result.ResultOfMap

设置操作返回的数据，数据使用自定义的key存储

Q

queryParam(String) - Method in class cool.scx.web.websocket.WebSocketRoutingContext

queryParams() - Method in class cool.scx.web.websocket.WebSocketRoutingContext

R

Raw - Class in cool.scx.web.vo

原始文件 但不需要下载的 vo 比如 pdf 之类

readJson(String) - Static method in class cool.scx.web.parameter_handler.RequestInfo

readValue(JsonNode, JavaType) - Static method in class cool.scx.web.ScxWebHelper

a

readXml(String) - Static method in class cool.scx.web.parameter_handler.RequestInfo

Redirection - Class in cool.scx.web.vo

重定向

registerHttpRoutes(Router, Object...) - Method in class cool.scx.web.ScxWeb

registerRoute(WebSocketRouter, Object...) - Method in class cool.scx.web.WebSocketRouteRegistrar

registerRoute(Router, Object...) - Method in class cool.scx.web.RouteRegistrar

registerWebSocketRoutes(WebSocketRouter, Object...) - Method in class cool.scx.web.ScxWeb

remove(String, Object) - Method in class cool.scx.web.vo.Result.ResultOfMap

RequestInfo - Class in cool.scx.web.parameter_handler

封装 RoutingContext 的参数 防止反复取值造成性能损失

RequestInfo(RoutingContext) - Constructor for class cool.scx.web.parameter_handler.RequestInfo

RequestInfo.ContentType - Enum Class in cool.scx.web.parameter_handler

required() - Element in annotation interface cool.scx.web.annotation.FromBody

是否必填

required() - Element in annotation interface cool.scx.web.annotation.FromPath

是否必填

required() - Element in annotation interface cool.scx.web.annotation.FromQuery

是否必填

required() - Element in annotation interface cool.scx.web.annotation.FromUpload

是否必填

RequiredParamEmptyException - Exception Class in cool.scx.web.parameter_handler.exception

必须参数缺失异常

RequiredParamEmptyException(String) - Constructor for exception class cool.scx.web.parameter_handler.exception.RequiredParamEmptyException

responseCanUse(RoutingContext) - Static method in class cool.scx.web.ScxWebHelper

Result - Class in cool.scx.web.vo

一般用来表达业务逻辑

Result() - Constructor for class cool.scx.web.vo.Result

Result.Body<T> - Record Class in cool.scx.web.vo

Result.ResultOfData - Class in cool.scx.web.vo

Result.ResultOfMap - Class in cool.scx.web.vo

ResultOfData(String, Object) - Constructor for class cool.scx.web.vo.Result.ResultOfData

ReturnValueHandler - Interface in cool.scx.web.return_value_handler

返回值处理器

RouteRegistrar - Class in cool.scx.web

路由注册器

RouteRegistrar(ScxWeb) - Constructor for class cool.scx.web.RouteRegistrar

扫描所有被 ScxMapping注解标记的方法 并封装为 ScxMappingHandler.

routingContext() - Method in class cool.scx.web.parameter_handler.RequestInfo

routingContext() - Static method in class cool.scx.web.ScxWeb

获取当前线程的 RoutingContext (只限在 scx mapping 注解的方法及其调用链上)

RoutingContextParameterHandler - Class in cool.scx.web.parameter_handler

类型为 RoutingContext 的参数处理器

RoutingContextParameterHandler() - Constructor for class cool.scx.web.parameter_handler.RoutingContextParameterHandler

S

ScxHttpException - Exception Class in cool.scx.web.exception

在 ScxRoute 注解标记的方法中抛出此异常会被 ScxRouteHandler 进行截获并进行处理

ScxHttpException(HttpStatusCode) - Constructor for exception class cool.scx.web.exception.ScxHttpException

ScxHttpException(HttpStatusCode, String) - Constructor for exception class cool.scx.web.exception.ScxHttpException

ScxHttpException(HttpStatusCode, String, Throwable) - Constructor for exception class cool.scx.web.exception.ScxHttpException

ScxHttpException(HttpStatusCode, Throwable) - Constructor for exception class cool.scx.web.exception.ScxHttpException

ScxHttpExceptionHandler - Class in cool.scx.web.exception_handler

ScxHttpException 处理器

ScxHttpExceptionHandler(boolean) - Constructor for class cool.scx.web.exception_handler.ScxHttpExceptionHandler

ScxRoute - Annotation Interface in cool.scx.web.annotation

路由注解 默认会在方法上进行继承 如果想在子类禁用 请使用 NoScxRoute

ScxRouteHandler - Class in cool.scx.web

ScxRouteHandler class.

ScxTemplateHandler - Class in cool.scx.web.template

模板处理器

ScxTemplateHandler(Path) - Constructor for class cool.scx.web.template.ScxTemplateHandler

ScxWeb - Class in cool.scx.web

ScxWeb() - Constructor for class cool.scx.web.ScxWeb

ScxWeb(ScxWebOptions) - Constructor for class cool.scx.web.ScxWeb

ScxWebHelper - Class in cool.scx.web

ScxWebHelper() - Constructor for class cool.scx.web.ScxWebHelper

ScxWebOptions - Class in cool.scx.web

ScxWebOptions() - Constructor for class cool.scx.web.ScxWebOptions

ScxWebSocketRoute - Annotation Interface in cool.scx.web.annotation

ScxWebSocketRoute websocket 映射 设置此注解的方法 必须同时 继承 BaseWSHandler 才可以生效

SEND_FILE_HELPER - Static variable in class cool.scx.web._hack.SendFileHelper

sendBytes(RoutingContext) - Method in class cool.scx.web.vo.Download

sendBytes(RoutingContext) - Method in class cool.scx.web.vo.Raw

sendFile(RoutingContext) - Method in class cool.scx.web.vo.Download

sendFile(RoutingContext) - Method in class cool.scx.web.vo.Raw

SendFileHelper - Class in cool.scx.web._hack

sendHtmlPath(RoutingContext) - Method in class cool.scx.web.vo.Html

sendHtmlStr(RoutingContext) - Method in class cool.scx.web.vo.Html

sendInputStream(RoutingContext) - Method in class cool.scx.web.vo.Download

sendInputStream(RoutingContext) - Method in class cool.scx.web.vo.Raw

sendStatic(RoutingContext, FileSystem, String, boolean) - Method in class cool.scx.web._hack.SendFileHelper

sendStatic(RoutingContext, FileSystem, String, boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

Can be called recursive for index pages

sendToClient(int, String, String, RoutingContext) - Static method in class cool.scx.web.exception_handler.ScxHttpExceptionHandler

setAllowRootFileSystemAccess(boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

Deprecated.

- Use the parameters in constructor

setAlwaysAsyncFS(boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

setCacheEntryTimeout(long) - Method in class cool.scx.web._hack.StaticHandlerImpl

setCachingEnabled(boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

setDefaultContentEncoding(String) - Method in class cool.scx.web._hack.StaticHandlerImpl

setDirectoryListing(boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

setDirectoryTemplate(String) - Method in class cool.scx.web._hack.StaticHandlerImpl

setEnableFSTuning(boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

setEnableRangeSupport(boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

setFilesReadOnly(boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

setHttp2PushMapping(List<Http2PushMapping>) - Method in class cool.scx.web._hack.StaticHandlerImpl

setIncludeHidden(boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

setIndexPage(String) - Method in class cool.scx.web._hack.StaticHandlerImpl

setInterceptor(Interceptor) - Method in class cool.scx.web.ScxWeb

setMaxAgeSeconds(long) - Method in class cool.scx.web._hack.StaticHandlerImpl

setMaxAvgServeTimeNs(long) - Method in class cool.scx.web._hack.StaticHandlerImpl

setMaxCacheSize(int) - Method in class cool.scx.web._hack.StaticHandlerImpl

setSendVaryHeader(boolean) - Method in class cool.scx.web._hack.StaticHandlerImpl

setWebRoot(String) - Method in class cool.scx.web._hack.StaticHandlerImpl

Deprecated.

- Use the parameters in constructor

skipCompressionForMediaTypes(Set<String>) - Method in class cool.scx.web._hack.StaticHandlerImpl

skipCompressionForSuffixes(Set<String>) - Method in class cool.scx.web._hack.StaticHandlerImpl

StaticHandlerImpl - Class in cool.scx.web._hack

Copy From StaticHandlerImpl Make Some private to public so we can Override Static web server Parts derived from Yoke

StaticHandlerImpl() - Constructor for class cool.scx.web._hack.StaticHandlerImpl

Default constructor with DEFAULT_WEB_ROOT and relative file access only

StaticHandlerImpl(FileSystemAccess, String) - Constructor for class cool.scx.web._hack.StaticHandlerImpl

Constructor called by static factory method

statusCode() - Method in exception class cool.scx.web.exception.ScxHttpException

StringReturnValueHandler - Class in cool.scx.web.return_value_handler

String 类型处理器

StringReturnValueHandler() - Constructor for class cool.scx.web.return_value_handler.StringReturnValueHandler

T

Template - Class in cool.scx.web.vo

模板

templateHandler() - Method in class cool.scx.web.ScxWeb

TemplateReturnValueHandler - Class in cool.scx.web.return_value_handler

用于渲染 freemarker

TemplateReturnValueHandler(ScxTemplateHandler) - Constructor for class cool.scx.web.return_value_handler.TemplateReturnValueHandler

templateRoot() - Method in class cool.scx.web.ScxWebOptions

templateRoot(Path) - Method in class cool.scx.web.ScxWebOptions

textData() - Method in class cool.scx.web.websocket.OnFrameRoutingContext

toJson(String) - Method in class cool.scx.web.vo.Result

toString() - Method in record class cool.scx.web.vo.Result.Body

Returns a string representation of this record class.

toVertxMethod(HttpMethod) - Static method in class cool.scx.web.ScxWebHelper

toXml(String) - Method in class cool.scx.web.vo.Result

tryReadOrTextNode(String) - Static method in class cool.scx.web.parameter_handler.RequestInfo

走到这里标识以上的匹配全部失败 , 这里不知道 body 的具体格式 所以进行猜测转换

type - Variable in class cool.scx.web.vo.Download

数据来源

type - Variable in class cool.scx.web.vo.Raw

数据来源

U

UnauthorizedException - Exception Class in cool.scx.web.exception

未认证异常 (未登录)

UnauthorizedException() - Constructor for exception class cool.scx.web.exception.UnauthorizedException

UnauthorizedException(String) - Constructor for exception class cool.scx.web.exception.UnauthorizedException

UnauthorizedException(String, Throwable) - Constructor for exception class cool.scx.web.exception.UnauthorizedException

UnauthorizedException(Throwable) - Constructor for exception class cool.scx.web.exception.UnauthorizedException

UnsupportedMediaTypeException - Exception Class in cool.scx.web.exception

415 参数异常

UnsupportedMediaTypeException() - Constructor for exception class cool.scx.web.exception.UnsupportedMediaTypeException

UnsupportedMediaTypeException(String) - Constructor for exception class cool.scx.web.exception.UnsupportedMediaTypeException

UnsupportedMediaTypeException(String, Throwable) - Constructor for exception class cool.scx.web.exception.UnsupportedMediaTypeException

UnsupportedMediaTypeException(Throwable) - Constructor for exception class cool.scx.web.exception.UnsupportedMediaTypeException

useAllBody() - Element in annotation interface cool.scx.web.annotation.FromBody

是否将整个请求体作为参数进行转换

useDevelopmentErrorPage() - Method in class cool.scx.web.ScxWebOptions

useDevelopmentErrorPage(boolean) - Method in class cool.scx.web.ScxWebOptions

useNameAsUrl() - Element in annotation interface cool.scx.web.annotation.ScxRoute

注意 : 仅当作用于方法时生效 !!!

V

value() - Element in annotation interface cool.scx.web.annotation.FromBody

此值用来控制取值方式 并和 useAllBody 相关 1, useAllBody 为 false 时 : value 为空时 会以参数名称为标准作为 value value 不为空时会先将 body 转换 map 对象 然后根据 value 进行分层获取 如 userList.name , name , car.color 等 会将前台发来的参数转换为 jsonTree 对象 并获取对应的节点 2, useAllBody 为 true 时 : value 的值则会被忽略 整个 请求体会被转换成参数

value() - Element in annotation interface cool.scx.web.annotation.FromPath

路径参数名称 默认为空 为空的情况下会将参数名称作为 路径参数名称

value() - Element in annotation interface cool.scx.web.annotation.FromQuery

查询参数名称 默认为空 为空的情况下会将方法参数名称作为 查询参数名称

value() - Element in annotation interface cool.scx.web.annotation.FromUpload

路径参数名称 默认为空 为空的情况下会将参数名称作为 路径参数名称

value() - Element in annotation interface cool.scx.web.annotation.ScxRoute

value() - Element in annotation interface cool.scx.web.annotation.ScxWebSocketRoute

websocket 映射路径

valueOf(String) - Static method in enum class cool.scx.web.parameter_handler.RequestInfo.ContentType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class cool.scx.web.parameter_handler.RequestInfo.ContentType

Returns an array containing the constants of this enum class, in the order they are declared.

variableName() - Method in interface cool.scx.web.template.BaseTemplateDirective

获取自定义 变量的名称

W

webSocket - Variable in class cool.scx.web.websocket.WebSocketRoutingContext

webSocket() - Method in class cool.scx.web.websocket.WebSocketRoutingContext

WebSocketRoute - Class in cool.scx.web.websocket

Scx WebSocket 路由

WebSocketRoute(int, String, BaseWebSocketHandler) - Constructor for class cool.scx.web.websocket.WebSocketRoute

Constructor for ScxWebSocketRoute.

WebSocketRoute(String, BaseWebSocketHandler) - Constructor for class cool.scx.web.websocket.WebSocketRoute

Constructor for ScxWebSocketRoute.

WebSocketRouter - Class in cool.scx.web.websocket

a

WebSocketRouter() - Constructor for class cool.scx.web.websocket.WebSocketRouter

WebSocketRouteRegistrar - Class in cool.scx.web

ScxWebSocketMappingRegistrar class.

WebSocketRouteRegistrar(ScxWeb) - Constructor for class cool.scx.web.WebSocketRouteRegistrar

WebSocketRoutingContext - Class in cool.scx.web.websocket

WebSocketRoutingContext(ServerWebSocket, List<WebSocketRoute>) - Constructor for class cool.scx.web.websocket.WebSocketRoutingContext

X

Xml - Class in cool.scx.web.vo

Xml 格式的返回值

XML - Enum constant in enum class cool.scx.web.parameter_handler.RequestInfo.ContentType

A B C D E F G H I J L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form