[
https://issues.apache.org/jira/browse/OFBIZ-4274?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13031517#comment-13031517
]
Adrian Crum edited comment on OFBIZ-4274 at 5/11/11 4:08 PM:
-------------------------------------------------------------
By default, request payloads (HTTP entity) are basically the target service's
parameters wrapped in the resource name. In an XML payload the service
parameters are child elements of the resource element (whose tag name is the
resource name). This approach leverages the existing service definitions to
define a REST resource API.
By default, response payloads are the service results. The service result Map
is converted to the requested media type.
In cases where the request payload is controlled by an external application, a
custom media handler can be provided for conversion. See the attached patch for
an example.
The servlet will support media handlers that convert payloads to/from media
types (XML, JSON). See the attached patch for an example.
was (Author: [email protected]):
By default, request payloads (HTTP entity) are basically the target
service's parameters wrapped in the resource name. In an XML payload the
service parameters are child elements of the resource element (whose tag name
is the resource name). This approach leverages the existing service definitions
to define a REST resource API.
By default, response payloads are the service results. The service result Map
is converted to the requested media type.
In cases where the request payload is controlled by an external application,
the REST resource configuration could map the requests to a service that
performs a data conversion (or translation) and then calls OFBiz services with
the converted data. The method of converting service results into a response an
external application expects is undefined at this time. Supporting this type of
functionality (client-defined API) is beyond the scope of the initial
implementation. Installations requiring that kind of support could use an ESB
for translation.
The servlet will support pluggable converters that convert payloads to/from
media types (XML, JSON).
> Implement a REST Servlet
> ------------------------
>
> Key: OFBIZ-4274
> URL: https://issues.apache.org/jira/browse/OFBIZ-4274
> Project: OFBiz
> Issue Type: New Feature
> Components: framework
> Reporter: Adrian Crum
> Priority: Minor
> Attachments: RestConfig.patch
>
>
> Implement a REST servlet that will map REST requests to OFBiz services.
> Details are in the comments.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira