com.supermap.services.rest
类 JaxrsServletForJersey
- java.lang.Object
-
- HttpServlet
-
- com.supermap.services.rest.JaxrsServletForJersey
-
- 所有已实现的接口:
- InterfaceContextAware
- 直接已知子类:
- DistributeAnalystServlet
public class JaxrsServletForJersey extends HttpServlet implements InterfaceContextAware
基于JAX-RS 标准的 REST 应用的 Servlet 类,用于以 SCA 方式发布 REST 服务信息。
-
-
嵌套类概要
嵌套类 限定符和类型 类和说明 static class
JaxrsServletForJersey.JerseyServletConfig
基于JAX-RS 标准的 REST 应用的 Servlet 的配置类。protected static class
JaxrsServletForJersey.RequestNotCompleteException
请求未结束异常。protected static class
JaxrsServletForJersey.RequestWrapper
HTTP 请求处理类,用于转换 URI 路径,使 HTTP 请求适应 Servlet 的要求。
-
构造器概要
构造器 构造器和说明 JaxrsServletForJersey()
构造函数。
-
方法概要
方法 限定符和类型 方法和说明 protected boolean
checkOpenApiByInterfaceContext(InterfaceContext interfaceContext)
根据接口上下文中的服务组件信息,判定特定的rest服务模块是否需要开启openapi。protected JaxrsServletForJersey.RequestWrapper
createRequestWrapper(HttpServletRequest request)
创建请求对象处理类,用于生成对应本 Servlet 的请求对象。void
destroy()
销毁对象。java.lang.String
getId()
InterfaceContext
getInterfaceContext()
获取服务接口上下文。protected java.lang.String
getJaxrsApplicationName()
获取Jaxrs应用类的名称。protected ServletContainer
getServletContainer()
获取Servlet容器。protected java.lang.String
getURLQueryParamValue(HttpServletRequest request, java.lang.String paramName)
获取请求中的url查询参数中指定名字的参数 如果有同名的参数,返回值用%_来分隔各个参数值。JaxrsServletForJersey.JerseyServletConfig
newJerseyServletConfig(ServletConfig servletConfig)
void
service(HttpServletRequest request, HttpServletResponse response)
提供从 URI 到 REST 资源的请求转发处理。void
setInterfaceContext(InterfaceContext interfaceContext)
设置服务接口上下文,用于注入接口上下文对象。void
setJaxrsApplication(javax.ws.rs.core.Application value)
void
setJaxrsApplicationClass(java.lang.Class<? extends javax.ws.rs.core.Application> clz)
设置Jaxrs应用类。void
setJaxrsApplicationName(java.lang.String value)
设置Jaxrs应用类的名称。protected void
setMockRequestEntity(JaxrsServletForJersey.RequestWrapper request)
设置模拟的请求体。
-
-
-
方法详细资料
-
getInterfaceContext
public InterfaceContext getInterfaceContext()
获取服务接口上下文。
- 返回:
- 服务接口上下文。
-
setInterfaceContext
public void setInterfaceContext(InterfaceContext interfaceContext)
设置服务接口上下文,用于注入接口上下文对象。
- 指定者:
setInterfaceContext
在接口中InterfaceContextAware
- 参数:
interfaceContext
- 服务接口上下文接口。
-
service
public void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, java.io.IOException
提供从 URI 到 REST 资源的请求转发处理。
- 参数:
request
- 请求对象。response
- 响应对象。- 抛出:
ServletException
- Servlet 异常。java.io.IOException
- 失败或中断的 I/O 操作生成的异常。
-
destroy
public void destroy()
销毁对象。
-
createRequestWrapper
protected JaxrsServletForJersey.RequestWrapper createRequestWrapper(HttpServletRequest request) throws JaxrsServletForJersey.RequestNotCompleteException
创建请求对象处理类,用于生成对应本 Servlet 的请求对象。
- 参数:
request
- 请求对象。- 返回:
- HTTP 请求处理对象。
- 抛出:
JaxrsServletForJersey.RequestNotCompleteException
- 请求未完成异常。
-
setMockRequestEntity
protected void setMockRequestEntity(JaxrsServletForJersey.RequestWrapper request) throws JaxrsServletForJersey.RequestNotCompleteException
设置模拟的请求体。- 参数:
request
-- 抛出:
JaxrsServletForJersey.RequestNotCompleteException
-
getURLQueryParamValue
protected java.lang.String getURLQueryParamValue(HttpServletRequest request, java.lang.String paramName)
获取请求中的url查询参数中指定名字的参数 如果有同名的参数,返回值用%_来分隔各个参数值。 返回值值是解码过的。
-
getServletContainer
protected ServletContainer getServletContainer()
获取Servlet容器。
- 返回:
-
getJaxrsApplicationName
protected java.lang.String getJaxrsApplicationName()
获取Jaxrs应用类的名称。
- 返回:
-
checkOpenApiByInterfaceContext
protected boolean checkOpenApiByInterfaceContext(InterfaceContext interfaceContext)
根据接口上下文中的服务组件信息,判定特定的rest服务模块是否需要开启openapi。- 参数:
interfaceContext
-- 返回:
-
setJaxrsApplicationName
public void setJaxrsApplicationName(java.lang.String value)
设置Jaxrs应用类的名称。
- 参数:
value
-- 从以下版本开始:
- 7.0.1
-
setJaxrsApplication
public void setJaxrsApplication(javax.ws.rs.core.Application value)
-
setJaxrsApplicationClass
public void setJaxrsApplicationClass(java.lang.Class<? extends javax.ws.rs.core.Application> clz)
设置Jaxrs应用类。 相当于调用setJaxrsApplicationName(clz.getName())。
- 参数:
clz
-- 从以下版本开始:
- 7.0.1
-
newJerseyServletConfig
public JaxrsServletForJersey.JerseyServletConfig newJerseyServletConfig(ServletConfig servletConfig)
-
getId
public java.lang.String getId()
-
-