com.supermap.services.rest

Class JaxrsServletForJersey

java.lang.Object

HttpServlet

com.supermap.services.rest.JaxrsServletForJersey

All Implemented Interfaces:

InterfaceContextAware

Direct Known Subclasses:

DistributeAnalystServlet

public class JaxrsServletForJersey
extends HttpServlet
implements InterfaceContextAware

The Servlet class of JAX-RS standard based REST application, which is used for publishing REST service information by using SCA method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JaxrsServletForJersey.JerseyServletConfig The Servlet config class of REST application based on JaX-RS standard.
protected static class	JaxrsServletForJersey.RequestNotCompleteException Request incomplete exception, which means the current request is just a part of complete request.
protected static class	JaxrsServletForJersey.RequestWrapper HTTP request handling class, which is used to transform the URI path.

Constructor Summary

Constructors

Constructor and Description
JaxrsServletForJersey() The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected JaxrsServletForJersey.RequestWrapper	createRequestWrapper(HttpServletRequest request) Creates request object handle class, to generate the request object corresponding to the Servlet.
void	destroy() Destroys object.
java.lang.String	getId()
InterfaceContext	getInterfaceContext() Gets the service interface context.
protected java.lang.String	getJaxrsApplicationName() Gets the Jaxts application name.
protected ServletContainer	getServletContainer() Gets the Servlet container.
protected java.lang.String	getURLQueryParamValue(HttpServletRequest request, java.lang.String paramName) Gets the specified query parameter in the request url, if there is parameters with the same name, the return value will use "%_" to separate the parameters.
JaxrsServletForJersey.JerseyServletConfig	newJerseyServletConfig(ServletConfig servletConfig)
void	service(HttpServletRequest request, HttpServletResponse response) Provides the request forward processing from URI to REST resource.
void	setInterfaceContext(InterfaceContext interfaceContext) Sets the service interface context to inject interface context object.
void	setJaxrsApplication(javax.ws.rs.core.Application value)
void	setJaxrsApplicationClass(java.lang.Class<? extends javax.ws.rs.core.Application> clz) Sets the Jaxts application class.
void	setJaxrsApplicationName(java.lang.String value) Sets the Jaxts application name.
protected void	setMockRequestEntity(JaxrsServletForJersey.RequestWrapper request) Sets the mocked request body.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JaxrsServletForJersey

public JaxrsServletForJersey()

The constructor.

Method Detail

getInterfaceContext

public InterfaceContext getInterfaceContext()

Gets the service interface context.

Returns:

The service interface context.

setInterfaceContext

public void setInterfaceContext(InterfaceContext interfaceContext)

Sets the service interface context to inject interface context object.

Specified by:

setInterfaceContext in interface InterfaceContextAware

Parameters:

interfaceContext - The service interface context interface.

service

public void service(HttpServletRequest request,
           HttpServletResponse response)
             throws ServletException,
                    java.io.IOException

Provides the request forward processing from URI to REST resource.

Parameters:

request - The request object.

response - The response object.

Throws:

ServletException - Servlet exception.

java.io.IOException - Exception generated by I/O operation failure or break.

destroy

public void destroy()

Destroys object.

createRequestWrapper

protected JaxrsServletForJersey.RequestWrapper createRequestWrapper(HttpServletRequest request)
                                                             throws JaxrsServletForJersey.RequestNotCompleteException

Creates request object handle class, to generate the request object corresponding to the Servlet.

Parameters:

request - The request object.

Returns:

HTTP request handle object.

Throws:

JaxrsServletForJersey.RequestNotCompleteException - Request incomplete exception.

setMockRequestEntity

protected void setMockRequestEntity(JaxrsServletForJersey.RequestWrapper request)
                             throws JaxrsServletForJersey.RequestNotCompleteException

Sets the mocked request body.

Parameters:

request -

Throws:

JaxrsServletForJersey.RequestNotCompleteException

getURLQueryParamValue

protected java.lang.String getURLQueryParamValue(HttpServletRequest request,
                                     java.lang.String paramName)

Gets the specified query parameter in the request url, if there is parameters with the same name, the return value will use "%_" to separate the parameters. The return values are decoded.

getServletContainer

protected ServletContainer getServletContainer()

Gets the Servlet container.

Returns:

getJaxrsApplicationName

protected java.lang.String getJaxrsApplicationName()

Gets the Jaxts application name.

Returns:

setJaxrsApplicationName

public void setJaxrsApplicationName(java.lang.String value)

Sets the Jaxts application name.

Parameters:

value -

Since:

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)

Sets the Jaxts application class. It is equivalent to call etJaxrsApplicationName(clz.getName()).

Parameters:

clz -

Since:

7.0.1

newJerseyServletConfig

public JaxrsServletForJersey.JerseyServletConfig newJerseyServletConfig(ServletConfig servletConfig)

getId

public java.lang.String getId()