A.2. RESTEasy 配置参数


表 A.2. 元素
选项名称默认值描述

resteasy.servlet.mapping.prefix

没有默认

如果 Resteasy servlet-mapping 的 URL-pattern 不是 /*

resteasy.scan

false

@Provider 和 JAX -RS 资源类型(如 @ Path 、@GET、@POST)自动扫描 WEB-INF/lib JARs 和 WEB-INF/classes 目录,并进行注册。

resteasy.scan.providers

false

扫描 @Provider 类并注册它们。

resteasy.scan.resources

false

扫描 JAX-RS 资源类.

resteasy.providers

no default

以逗号分隔的列表,其中包含您希望 注册的完全限定 @Provider 类名称。

resteasy.use.builtin.providers

true

是否要注册默认的内置 @Provider 类.

resteasy.resources

没有默认

以逗号分隔的列表,其中包含您要注册的完全限定 JAX-RS 资源类型名称。

resteasy.jndi.resources

没有默认

以逗号分隔的 JNDI 名称列表,引用您要注册为 JAX-RS 资源的对象。

javax.ws.rs.Application

没有默认

以 spec 可移植的方式将应用程序 类的 完全限定名称到 bootstrap。

resteasy.media.type.mappings

没有默认

将文件名扩展名(如 .xml.txt)映射到介质类型,取代 Accept 标头的需求。客户端无法使用 Accept 标头来选择表示法(如浏览器)。您可以在 WEB-INF/web.xml 文件中使用 resteasy.media.type.mappingsresteasy.language.mappings 配置此项。

resteasy.language.mappings

没有默认

将文件名扩展(如. en.fr)映射到语言,不再需要 Accept-Language 标头。当客户端无法使用 Accept-Language 标头来选择语言(如浏览器)时使用。

resteasy.document.expand.entity.references

false

是否扩展外部实体,还是将它们替换为空字符串。在 JBoss EAP 中,此参数默认为 false,因此它将它们替换为空字符串。

resteasy.document.secure.processing.feature

true

在处理 org.w3c.dom.Document 文档和 JAXB 对象表示时实施安全限制。

resteasy.document.secure.disableDTDs

true

禁止 org.w3c.dom.Document 文档和 JAXB 对象表示中的 DTDs。

resteasy.wider.request.matching

true

关闭 JAX-RS 规范中定义的类级表达式过滤,而是根据各个 JAX-RS 方法的完整表达式进行匹配。

resteasy.use.container.form.params

true

使用 HttpServletRequest.getParameterMap() 方法来获取表单参数。如果您在 servlet 过滤器中调用此方法或者在过滤器内消耗输入流,请使用这个切换。

resteasy.add.charset

true

如果资源方法返回了 文本/*应用程序/xml* 介质类型,但没有显式 charset,RESTEasy 会将 charset=UTF-8 添加到返回的内容类型标头中。请注意,charset 在此情况下默认为 UTF-8,独立于此参数的设置。

注意

这些参数在 WEB-INF/web.xml 文件中配置。

重要

在 Servlet 3.0 容器中,web .xml 文件中的 resteasy.scan. * 配置将被忽略,所有标有 JAX-RS 的组件将被自动扫描。

例如,javax.ws.rs.Application 参数是在 servlet 配置 的 init-param 中配置的:

<servlet>
    <servlet-name>Resteasy</servlet-name>
    <servlet-class>org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher</servlet-class>
    <init-param>
        <param-name>javax.ws.rs.Application</param-name>
        <param-value>org.jboss.resteasy.utils.TestApplication</param-value>
    </init-param>
</servlet>

例如,resteasy.document.expand.entity.referencescontext-param 中配置:

<context-param>
    <param-name>resteasy.document.expand.entity.references</param-name>
    <param-value>true</param-value>
</context-param>
警告

更改以下 RESTEasy 参数的默认值可能会导致 RESTEasy 应用程序受到 XXE 攻击的影响:

  • resteasy.document.expand.entity.references
  • resteasy.document.secure.processing.feature
  • resteasy.document.secure.disableDTDs
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.