RestConfig

java.lang.Object
- com.supermap.services.rest.RestConfig

所有已实现的接口:

java.io.Serializable
```
public class RestConfig
extends java.lang.Object
implements java.io.Serializable
```
REST 应用配置类，负责配置的加载及解析。

另请参阅:

序列化表格

字段概要

字段
限定符和类型字段和说明

static java.lang.String defaultConfigFileName
默认的配置的文件名。

字段
限定符和类型	字段和说明
`static java.lang.String`	`defaultConfigFileName` 默认的配置的文件名。

构造器概要

构造器
构造器和说明

RestConfig()

构造器
构造器和说明
`RestConfig()`

方法概要

方法
限定符和类型	方法和说明
`boolean`	`equals(java.lang.Object obj)` 验证是否为资源配置对象。
`java.lang.String`	`getAccessControlAllowOrigin()` 获取访问控制允许的初始值。
`java.util.Map<java.lang.String,java.lang.String>`	`getComponentResourceMapping()` 获取业务组件与资源配置文件名的映射关系。
`static RestConfig`	`getDefaultConfig()` 获取默认的配置。
`double`	`getDefaultHoldTime()` 获取临时资源的默认存活时间。
`java.lang.String`	`getDefaultHttpActionHandlerBeanName()` 获取默认请求处理器的bean名称。
`MediaType`	`getDefaultMediaType()` 获取默认的资源表述类型。
`java.util.List<java.lang.String>`	`getExtensionResourceFinderBeanNames()` 获取资源加载器。
`java.util.List<MediaTypeMappingInfo>`	`getRelationInfos()` 获取关联信息。
`java.lang.String`	`getResourceFileNames()` 获取资源文件的名称。
`java.util.Map`	`getRestConfigMap()` 获取保存了应用配置信息的 java.util.Map 对象，其中，键为配置项名称，值为配置项的值。
`java.lang.String`	`getRootPath()` 获取 REST 应用的根目录。
`java.util.List<java.lang.String>`	`getSystemDecoderBeanNames()` 获取请求参数解析器。
`java.util.List<java.lang.String>`	`getSystemEncoderBeanNames()` 获取资源表述生成器。
`int`	`hashCode()` 获取对象实例的哈希值
`boolean`	`isDebug()` 判断是否以 Debug 模式运行应用。
`boolean`	`isSecurityControlEnable()` 判断是否加载安全控制器。
`static RestConfig`	`parse(java.io.File restConfigFile)` 从文件系统中的一个文件加载应用配置。
`static RestConfig`	`parse(java.util.Map configMap)` 根据一个 Map 对象，得到一个 REST 应用配置。
`void`	`removeCurrentThreadRootPath()`
`void`	`setAccessControlAllowOrigin(java.lang.String accessControlAllowOrigin)` 设置访问控制允许的初始值。
`void`	`setComponentResourceMapping(java.util.Map<java.lang.String,java.lang.String> componentResourceMapping)` 设置业务组件与资源配置文件名的映射关系。
`void`	`setCurrentThreadRootPath(java.lang.String value)`
`void`	`setDebug(boolean isDebug)` 设置是否采用调试模式的标志。
`void`	`setDefaultHoldTime(double defaultHoldTime)` 设置临时资源的默认存活时间。
`void`	`setDefaultHttpActionHandlerBeanName(java.lang.String defaultHttpActionHandlerBeanName)` 设置默认请求处理器的bean名称。
`void`	`setDefaultMediaType(MediaType defaultMediaType)` 设置资源默认的表述类型。
`void`	`setExtensionResourceFinderBeanNames(java.util.List<java.lang.String> extensionResourceFinderBeanNames)` 设置资源加载器的名称列表。
`void`	`setRelationInfos(java.util.List<MediaTypeMappingInfo> relationInfos)` 设置 URI 后缀跟媒体类型的关联信息。
`void`	`setResourceFileNames(java.lang.String resourceFileNames)` 设置资源文件的名称。
`void`	`setRootPath(java.lang.String rootPath)` 设置 REST 应用的根目录。
`void`	`setSecurityControlEnable(boolean securityControlEnable)` 设置是否加载安全控制器。
`void`	`setSystemDecoderBeanNames(java.util.List<java.lang.String> systemDecoderBeanNames)` 设置请求参数解析器。
`void`	`setSystemEncoderBeanNames(java.util.List<java.lang.String> systemEncoderBeanNames)` 设置资源表述生成器。

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - defaultConfigFileName
```
public static final java.lang.String defaultConfigFileName
```
    默认的配置的文件名。
    
    如“config/rest/AppContext.xml”。
- 构造器详细资料
  - RestConfig
```
public RestConfig()
```
- 方法详细资料
  - getRootPath
```
public java.lang.String getRootPath()
```
    获取 REST 应用的根目录。
    
    例如：REST 应用的根目录为：“/services/rest”，则 REST 应用发布在本机 8090 端口时，根资源的 URI 为：http://localhost:8090/services/rest，相应地，maps 资源的 URI 为：http://localhost:8090/services/rest/maps。
    
    返回:
    
    REST 应用的根目录字符串。
  - setCurrentThreadRootPath
```
public void setCurrentThreadRootPath(java.lang.String value)
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    验证是否为资源配置对象。
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    
    obj -
    
    返回:
  - hashCode
```
public int hashCode()
```
    获取对象实例的哈希值
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    返回:
    
    哈希值
  - getRestConfigMap
```
public java.util.Map getRestConfigMap()
```
    获取保存了应用配置信息的 java.util.Map 对象，其中，键为配置项名称，值为配置项的值。
    
    返回:
    
    REST 配置信息映射。
  - setDebug
```
public void setDebug(boolean isDebug)
```
    设置是否采用调试模式的标志。
    
    在调试模式下，服务器响应的所有表述的媒体类型都是 text/plain，以利于调试。
    
    参数:
    
    isDebug - isDebug 为 true 表示设置为调试模式，否则表示设置为非调试模式。
  - setSecurityControlEnable
```
public void setSecurityControlEnable(boolean securityControlEnable)
```
    设置是否加载安全控制器。
    
    参数:
    
    securityControlEnable - boolean 值，设为 true 表示加载安全控制器，否则表示不加载。
  - setRootPath
```
public void setRootPath(java.lang.String rootPath)
```
    设置 REST 应用的根目录。
    
    参数:
    
    rootPath - REST 应用的根路径字符串。
  - getExtensionResourceFinderBeanNames
```
public java.util.List<java.lang.String> getExtensionResourceFinderBeanNames()
```
    获取资源加载器。
    
    返回:
    
    默认的资源加载器的 Spring Bean 名称序列。
  - setExtensionResourceFinderBeanNames
```
public void setExtensionResourceFinderBeanNames(java.util.List<java.lang.String> extensionResourceFinderBeanNames)
```
    设置资源加载器的名称列表。
    
    参数:
    
    extensionResourceFinderBeanNames - 资源加载器的名称列表。
  - getResourceFileNames
```
public java.lang.String getResourceFileNames()
```
    获取资源文件的名称。
    
    返回:
    
    资源文件的名称。
  - setResourceFileNames
```
public void setResourceFileNames(java.lang.String resourceFileNames)
```
    设置资源文件的名称。
    
    参数:
    
    resourceFileNames - 资源文件的名称。
  - getDefaultMediaType
```
public MediaType getDefaultMediaType()
```
    获取默认的资源表述类型。
    
    当获取一个资源的表述时，没有给定表述类型，则返回默认类型的内容。当表述类型不支持时，则用默认类型的内容给出错误信息。
    
    返回:
    
    资源表述类型。
  - setDefaultMediaType
```
public void setDefaultMediaType(MediaType defaultMediaType)
```
    设置资源默认的表述类型。
    
    所有的 URI 的后缀与媒体类型都有关联关系，如 .json 表示媒体类型为 application/json，但如果 URI 没有后缀，则对资源的表述要使用默认的表述类型。
    
    参数:
    
    defaultMediaType - 欲设置的资源表述类型。
  - setRelationInfos
```
public void setRelationInfos(java.util.List<MediaTypeMappingInfo> relationInfos)
```
    设置 URI 后缀跟媒体类型的关联信息。
    
    参数:
    
    relationInfos - 关联信息序列。
  - setSystemEncoderBeanNames
```
public void setSystemEncoderBeanNames(java.util.List<java.lang.String> systemEncoderBeanNames)
```
    设置资源表述生成器。
    
    参数:
    
    systemEncoderBeanNames - 资源表述生成器的名称序列。
  - getSystemEncoderBeanNames
```
public java.util.List<java.lang.String> getSystemEncoderBeanNames()
```
    获取资源表述生成器。
    
    返回:
    
    资源表述生成器的 Spring Bean 名称序列。
  - getRelationInfos
```
public java.util.List<MediaTypeMappingInfo> getRelationInfos()
```
    获取关联信息。
    
    所有的 URI 的后缀与媒体类型都有关联关系，如 .json 表示媒体类型为 application/json。本函数就是获取所有的关联关系。
    
    返回:
    
    关联信息序列。
  - getSystemDecoderBeanNames
```
public java.util.List<java.lang.String> getSystemDecoderBeanNames()
```
    获取请求参数解析器。
    
    返回:
    
    请求参数解析器的 Spring Bean 名称序列。
  - setSystemDecoderBeanNames
```
public void setSystemDecoderBeanNames(java.util.List<java.lang.String> systemDecoderBeanNames)
```
    设置请求参数解析器。
    
    参数:
    
    systemDecoderBeanNames - 欲设置的请求参数解析器的 Spring Bean 名称序列。
  - isDebug
```
public boolean isDebug()
```
    判断是否以 Debug 模式运行应用。
    
    对于某些媒体类型的响应对象，客户端浏览器是不能解析的，例如 application/json。如果不以 Debug 模式运行，客户端会直接保存成一个文件，而不能在浏览器中直接显示该媒体类型相应对象的内容；如果以 Debug 模式运行，响应对象（设为 JSON 类型的）就可以显示在客户端浏览器上，这时的消息体中的媒体类型就不是原来的 application/json，而被转化成了客户端浏览器可以解析的媒体类型。可以方便调试。
    
    返回:
    
    true 表示以 Debug 模式运行应用，false 表示不以 Debug 模式运行应用。
  - isSecurityControlEnable
```
public boolean isSecurityControlEnable()
```
    判断是否加载安全控制器。
    
    返回:
    
    加载安全控制器，则返回 true，否则返回 false。
  - getComponentResourceMapping
```
public java.util.Map<java.lang.String,java.lang.String> getComponentResourceMapping()
```
    获取业务组件与资源配置文件名的映射关系。
    
    返回:
    
    业务组件与资源配置文件名的映射关系。
  - setComponentResourceMapping
```
public void setComponentResourceMapping(java.util.Map<java.lang.String,java.lang.String> componentResourceMapping)
```
    设置业务组件与资源配置文件名的映射关系。
    
    参数:
    
    componentResourceMapping - 业务组件与资源配置文件名的映射关系。
  - getDefaultHttpActionHandlerBeanName
```
public java.lang.String getDefaultHttpActionHandlerBeanName()
```
    获取默认请求处理器的bean名称。
    
    返回:
    
    默认请求处理器的bean名称。
  - setDefaultHttpActionHandlerBeanName
```
public void setDefaultHttpActionHandlerBeanName(java.lang.String defaultHttpActionHandlerBeanName)
```
    设置默认请求处理器的bean名称。
    
    参数:
    
    defaultHttpActionHandlerBeanName - 默认请求处理器的bean名称。
  - parse
```
public static RestConfig parse(java.io.File restConfigFile)
```
    从文件系统中的一个文件加载应用配置。
    
    要求该文件是一个 springBean 文件，文件中配置了 restConfig Bean 的信息，所有的配置都在该 Bean 中。
    
    参数:
    
    restConfigFile - 存储配置信息的配置文件。
    
    返回:
    
    RestConfig 对象。
  - parse
```
public static RestConfig parse(java.util.Map configMap)
```
    根据一个 Map 对象，得到一个 REST 应用配置。
    
    参数:
    
    configMap - 存放了应用配置信息的 java.util.Map 对象。
    
    返回:
    
    RestConfig 对象。
  - getDefaultConfig
```
public static RestConfig getDefaultConfig()
```
    获取默认的配置。
    
    返回:
    
    RestConfig 对象，即默认的资源配置。
  - getAccessControlAllowOrigin
```
public java.lang.String getAccessControlAllowOrigin()
```
    获取访问控制允许的初始值。
    
    返回:
    
    访问控制允许的初始值，该字段设置该REST服务可以被那些服务跨域访问。
  - setAccessControlAllowOrigin
```
public void setAccessControlAllowOrigin(java.lang.String accessControlAllowOrigin)
```
    设置访问控制允许的初始值。
    
    参数:
    
    accessControlAllowOrigin - 访问控制允许的初始值。
  - getDefaultHoldTime
```
public double getDefaultHoldTime()
```
    获取临时资源的默认存活时间。
    
    返回:
    
    临时资源的默认存活时间。
  - setDefaultHoldTime
```
public void setDefaultHoldTime(double defaultHoldTime)
```
    设置临时资源的默认存活时间。
    
    参数:
    
    defaultHoldTime - 临时资源的默认存活时间。
  - removeCurrentThreadRootPath
```
public void removeCurrentThreadRootPath()
```

类 RestConfig

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

defaultConfigFileName

构造器详细资料

RestConfig

方法详细资料

getRootPath

setCurrentThreadRootPath

equals

hashCode

getRestConfigMap

setDebug

setSecurityControlEnable

setRootPath

getExtensionResourceFinderBeanNames

setExtensionResourceFinderBeanNames

getResourceFileNames

setResourceFileNames

getDefaultMediaType

setDefaultMediaType

setRelationInfos

setSystemEncoderBeanNames

getSystemEncoderBeanNames

getRelationInfos

getSystemDecoderBeanNames

setSystemDecoderBeanNames

isDebug

isSecurityControlEnable

getComponentResourceMapping

setComponentResourceMapping

getDefaultHttpActionHandlerBeanName

setDefaultHttpActionHandlerBeanName

parse

parse

getDefaultConfig

getAccessControlAllowOrigin

setAccessControlAllowOrigin

getDefaultHoldTime

setDefaultHoldTime

removeCurrentThreadRootPath