uCosminexus Application Server, Web Service Development Guide

[Contents][Glossary][Index][Back][Next]

24.1 Support range of JAX-RS 1.1 specifications

This section describes the support range of the JAX-RS 1.1 specifications.

The following table describes the support range of the JAX-RS 1.1 specifications:

Table 24-1 Support range of the JAX-RS 1.1 specifications

Classification Support Remarks
Major classification# Minor classification
2 Application Built-in implementation Y The JAX-RS functionality of Cosminexus supports the servlet-based mechanism (described in the last paragraph of section 2.3.2 of the JAX-RS 1.1 specifications). Also, you do not need to implement the Application when implementing RESTful Web Services, because the JAX-RS functionality provides a default built-in Application implementation (customized implementation of the Application is not supported). For details on the built-in Application implementation and deployment, see 3.5.1 Configuring WAR files.
Customized implementation N
3.1, 3.3 Request method identifier Built-in implementation Y The JAX-RS functionality of Cosminexus supports the following standard request method identifiers defined in the JAX-RS 1.1 specifications:
  • GET annotation
  • POST annotation
  • PUT annotation
  • DELETE annotation
  • HEAD annotation
The JAX-RS functionality of Cosminexus does not support a customized implementation of the request method identifiers, which are optional in the JAX-RS 1.1 specifications.
Customized implementation N
3.1 Root resource class Y For details on the root resource class, see 17.1.1 Root resource class.
3.1 Life cycle of a root resource class Y For details on the life cycle of a root resource class, see 17.1.1(1) Life cycle.
3.1.2 Injection to the constructor parameter of a root resource class Y For details on injection to the constructor parameter of a root resource class, see
17.1.1(2) Constructors.
For details on the injectable types, or combination with the DefaultValue annotation, see 17.1.4 Parameter types.
3.2 Injection to the field and bean property Y For details on injection to the field and bean property, see 17.1.1(3) Field and bean property. For details on injectable types, or combination with the DefaultValue annotation, see 17.1.4 Parameter types.
3.3 Resource method Y For details on the resource method, see 17.1.1(4) Resource method.
3.3.2 Injection to the parameters of the resource method Y For details on injection to the parameter of a resource method, see 17.1.1(4) (b) Annotation of the parameter. For details on injectable types, or combination with the DefaultValue annotation, see 17.1.4 Parameter types.
3.3.2(1) Mapping from an entity body of an HTTP request to entity parameter Y For details on entity parameters, see 17.1.1(4) (c) Entity parameter.
3.3.3 Mapping from a return value to the HTTP response entity body Y For details on return value, see 17.1.1(4) (d) Return value.
3.2, 3.3.4 Exception handling Y For details on exceptions, see 17.1.5 Exception mapping.
3.3.5 Processing of HEAD HTTP and OPTIONS HTTP requests Y For details on processing of HEAD HTTP requests, see 24.3.2(3) javax.ws.rs.HEAD annotations. For details on processing of OPTIONS HTTP requests, see 24.3.2(4) javax.ws.rs.OPTIONS annotations.
3.4, 3.7.3 URI template and regular expressions Y For details on a URI template, see 17.1.6 URI template.
3.4.1 Sub-resource method Y For details on a sub-resource method, see 17.1.1 (5) Sub-resource method.
3.4.1 Sub-resource locator and Sub-resource Y For details on a sub-resource locator, see 17.1.1 (6) Sub-resource locator. For details on sub-resource class, see 17.1.7 Sub-resource class.
3.5 Media type declaration Y For details on a media type declaration, see 17.1.9 Media type declaration.
3.6 Annotation inheritance Y For details on an annotation inheritance, see 17.1.11 Annotation inheritance.
3.7 Mapping from an HTTP request to a resource method Y --
3.8 Determining a media type of an HTTP response Y --
4.2 Entity provider (Message body reader and writer) Built-in implementation Y You do not need to implement an entity provider when implementing RESTful Web Services, because the JAX-RS functionality of Cosminexus provides a built-in entity provider (customized implementation of the entity provider is not supported).
Built-in entity providers include entity providers that are supported additionally by the JAX-RS functionality, besides the entity providers for which support is mandatory according to the JAX-RS 1.1 specifications.
For details on the built-in entity providers and supported types, see 17.1.1(4)(c) Entity parameters.
Customized implementation N
4.3 Context provider N The JAX-RS functionality of Cosminexus processes the standard context of the JAX-RS 1.1 specifications appropriately, even without having to implement a context provider.
4.4 Exception mapping provider Y For details on the exception mapping provider, see 17.2.2 Exception mapping provider.
5 Context Y The JAX-RS functionality of Cosminexus supports the standard context type. For details on context, see 24.4 Context.
5.2.1 javax.ws.rs.core.Application N --
5.2.2 javax.ws.rs.core.UriInfo Y For details on javax.ws.rs.core.UriInfo, see 24.4.1 javax.ws.rs.core.UriInfo.
5.2.3 javax.ws.rs.core.HttpHeaders Y For details on javax.ws.rs.core.HttpHeaders, see 24.4.2 javax.ws.rs.core.HttpHeaders.
5.2.4 javax.ws.rs.core.Request Y For details on javax.ws.rs.core.Request, see 24.4.3 javax.ws.rs.core.Request.
5.2.5 javax.ws.rs.core.SecurityContext Y For details on javax.ws.rs.core.SecurityContext, see 24.4.4 javax.ws.rs.core.SecurityContext.
5.2.6 javax.ws.rs.ext.Providers Y For details on javax.ws.rs.ext.Providers, see 24.4.5 javax.ws.rs.core.ext.Providers.
6.1 javax.servlet.ServletConfig Y For details on javax.servlet.ServletConfig, see 24.4.6 javax.servlet.ServletConfig.
6.1 javax.servlet.ServletContext Y For details on javax.servlet.ServletContext, see 24.4.7 javax.servlet.ServletContext.
6.1 javax.servlet.http.HttpServletRequest Y For details on javax.servlet.http.HttpServletRequest, see 24.4.8 javax.servlet.http.HttpServletRequest.
6.1 javax.servlet.http.HttpServletResponse Y For details on javax.servlet.http.HttpServletResponse, see 24.4.9 javax.servlet.http.HttpServletResponse.
6.1 Execution environment based on a Servlet container (Web container) Y The JAX-RS functionality provides an execution environment for RESTful Web Services based on the servlet container. For details, see also 1.4.2(2) (c) Application.
6.1 Injection of the types defined in the servlet specifications Y See the following additional items:
  • javax.servlet.ServletConfig
  • javax.servlet.ServletContext
  • javax.servlet.http.HttpServletRequest
  • javax.servlet.http.HttpServletResponse
6.1 Processing the request entity streaming and committing a response within a method N The JAX-RS functionality of Cosminexus does not support the operations described in the latter half of the sub-section 6.1 of the JAX-RS 1.1 specifications.
6.2 Execution environment based on a Java EE container (EJB container) N --
7 Runtime delegate Y The JAX-RS functionality of Cosminexus is implemented according to the runtime delegate mechanism of the JAX-RS 1.1 specifications.
Apx.A Annotation Y For details on API, see 24.2 Support range of API.
Apx.B HTTP header Y --
JavaDoc API Y For details on API, see 24.2 Support range of API.

Legend:
Y: Supported
N: Not supported
--: Not applicable

#:
Indicates the corresponding places (chapters, sections, sub-sections) in the JAX-RS 1.1 specifications.