com.supermap.services.rest

类 RestContext

  • java.lang.Object
    • com.supermap.services.rest.RestContext


  • public class RestContext
    extends java.lang.Object
    

    REST 应用上下文。

    • 字段详细资料

      • DEFAULT_CONTEXT_FILENAME

        public static final java.lang.String DEFAULT_CONTEXT_FILENAME
        
        默认的 REST 应用上下文配置文件的路径(默认相对于安装根目录)。
      • DEFAULT_CONTEXT_JARPATH

        public static final java.lang.String DEFAULT_CONTEXT_JARPATH
        
        默认的 REST 应用上下文配置文件在 Jar 包中的路径(相对于 SuperMap iServer 的 Jar 包)。
      • CORE_BEAN_FILENAME

        public static final java.lang.String CORE_BEAN_FILENAME
        
        REST 应用核心组件(Bean)配置文件的路径(相对于 SuperMap iServer 的 Jar 包)。
      • EXTENDS_RESOURCE_FILENAME

        public static final java.lang.String EXTENDS_RESOURCE_FILENAME
        
        扩展资源的配置文件的路径(默认相对于安装根目录)。
      • APPBEANMAP

        public static final java.lang.String APPBEANMAP
        
        REST 应用的组件映射。
      • ERROR

        public static final java.lang.String ERROR
        

        错误信息“ERROR”。

    • 构造器详细资料

      • RestContext

        public RestContext()
        

        构造函数。

      • RestContext

        public RestContext(java.util.List<java.lang.Object> beans)
        

        默认构造函数。

      • RestContext

        public RestContext(java.lang.String appContextFileName)
        
        根据给定的 REST 应用上下文配置文件来构造一个应用上下文。
        参数:
        appContextFileName - REST 应用上下文配置文件路径。
      • RestContext

        public RestContext(java.io.File file,
                   java.util.List<java.lang.Object> beans)
        
        根据文件系统的一个上下文配置文件来构建一个 REST 应用上下文。
        参数:
        file - REST 应用上下文配置文件(File 对象)。
      • RestContext

        public RestContext(java.lang.String appContextFileName,
                   java.util.List<java.lang.Object> beans)
        

        构造函数。

        参数:
        appContextFileName - REST 应用上下文配置文件路径。
        beans - 上下文配置对象。
      • RestContext

        public RestContext(ResourceManager resourceManager,
                   RestConfig restConfig,
                   TempObjRepository tempObjRepository,
                   ResourceStatusManager resourceStatusManager)
        

        构造函数。

        通过资源管理对象、资源配置器、算法参数和算法结果仓库、资源状态管理器构造 REST 应用上下文对象。

        参数:
        resourceManager - 应用资源管理器。
        restConfig - 资源配置对象。
        tempObjRepository - 算法参数和算法结果仓库。
        resourceStatusManager - 资源状态管理器。
    • 方法详细资料

      • loadExpandPlugin

        protected void loadExpandPlugin(java.util.List components)
        
        初始化与相应服务组件相关的REST 服务接口插件。如过滤器,Encoder,Decoder 等。
        参数:
        components - 服务组件列表
      • get

        public java.lang.Object get(java.lang.String key)
        

        从 REST 应用上下文中获取一个属性。

        参数:
        key - 欲获取的属性字段名。
        返回:
        获取的属性的值。
      • put

        public java.lang.Object put(java.lang.String key,
                           java.lang.Object obj)
        

        给 REST 应用上下文添加一个属性值对。

        即给上下文添加一个属性字段,并赋值。

        参数:
        key - 欲添加的属性字段名。
        obj - 欲添加的属性字段值。
        返回:
      • remove

        public void remove(java.lang.String key)
        
      • getResourceManager

        public ResourceManager getResourceManager()
        

        获取 REST 应用上下文中的应用资源管理器。

        返回:
        上下文中的资源管理器。
      • setResourceManager

        public void setResourceManager(ResourceManager resourceManager)
        

        设置 REST 应用上下文中的资源管理器。

        参数:
        resourceManager - 欲设置的资源管理对象。
      • setRestConfig

        public void setRestConfig(RestConfig restConfig)
        

        设置 REST 应用上下文中的资源配置。

        参数:
        restConfig - 欲设值的资源配置对象。
      • getRestConfig

        public RestConfig getRestConfig()
        

        获取 REST 应用上下文中的资源配置。

        返回:
        本上下文中的资源配置对象。
      • getAttributes

        public java.util.Map getAttributes()
        

        获取 REST 应用上下文中的所有属性。

        返回:
        REST 应用上下文中的所有属性。
      • getTempObjRepository

        public TempObjRepository getTempObjRepository()
        

        获取 REST 应用上下文中的算法参数与算法结果仓库。

        算法参数与算法结果仓库,是保存算法结果、临时资源等的地方。

        返回:
        TempObjRepository 对象,REST 应用上下文中的算法参数与算法结果仓库。
      • setTempObjRepository

        public void setTempObjRepository(TempObjRepository tempObjRepository)
        

        设置 REST 应用上下文中的算法参数与算法结果仓库。

        参数:
        tempObjRepository - 欲设置的 TempObjRepository 对象。
      • setAttributes

        public void setAttributes(java.util.Map attributes)
        

        设置 REST 应用上下文中的所有属性。

        参数:
        attributes - 包含欲设置所有属性的 java.util.Map 对象。
      • getResourceStatusManager

        public ResourceStatusManager getResourceStatusManager()
        

        获取 REST 应用上下文中的资源状态管理器。

        返回:
        资源状态管理器对象。
      • setResourceStatusManager

        public void setResourceStatusManager(ResourceStatusManager resourceStatusManager)
        

        设置 REST 应用上下文中的资源状态管理器。

        参数:
        resourceStatusManager - 欲设置的资源状态管理器对象。
      • getSystemEncoders

        public java.util.List<Encoder> getSystemEncoders()
        

        获取默认的资源表述生成器。

        资源表述生成器用于将资源的状态转化成指定类型的表述,如 json 格式的表述。

        返回:
        默认的资源表述生成器序列。
      • getSystemDecoders

        public java.util.List<Decoder> getSystemDecoders()
        

        获取默认的参数解析器。

        参数解析器用于将某种类型的参数字符串反序列化成 Java 对象,如 json 格式的参数字符串。

        返回:
        默认的参数解析器序列。
      • getInterfaceContext

        public InterfaceContext getInterfaceContext()
        

        获取接口上下文。

        返回:
        接口上下文。
      • setInterfaceContext

        public void setInterfaceContext(InterfaceContext interfaceContext)
        

        设置接口上下文。

        参数:
        interfaceContext - 接口上下文。
      • getVerifier

        public Verifier getVerifier()
        
        返回REST 服务中的安全较验器。

        返回:
        安全较验器。
      • getVerifiers

        public java.util.List<Verifier> getVerifiers()
        
      • setVerifier

        public void setVerifier(Verifier verifier)
        

        设置REST服务中的安全较验器。

        参数:
        verifier - 安全较验器。