Skip to Content

Wiki source code of ERRest Framework

Version 53.1 by David Avendasora on 2011/03/15 10:44
Show last authors
1 = Presentations =
2
3 * A presentation made by Mike Schrag on February 16th 2010 about ERREST. http:~/~/webobjects.mdimension.com/wonder/screencasts/ERRest-2010-02-16.mov
4 It's also listed on the [[Screencasts Page>>http://www.wocommunity.org/webobjects_screencasts.html]] on wocommunity.org, in [[iTunes>>http://itunes.apple.com/us/podcast/webobjects-podcasts/id270165303]] and in the [[Podcasts RSS Feed>>http://www.wocommunity.org/podcasts/wopodcasts.xml]].
5
6 * Mike also did a session about it at WOWODC West 2009 (see below).
7
8 * A session on ERRest integration with Dogo was made by Pascal Robert at WOWODC 2010 (see below).
9
10 Current and past WOWODC Sessions are available for purchase on the WebObjects Community Association website.
11
12 1. Log in, or create an account here: http:~/~/www.wocommunity.org/apps/WebObjects/WOCommunity.woa/
13 1. Go to the Community Store where there will be options for purchasing memberships
14
15 = Class names vs Entity names =
16
17 Everything internally in ERRest is based on entity names, as it is throughout WebObjects and EOF.
18
19 Most times your Entity Name will be the same as your Class name, but because Entity names must be unique there are situations where you will need to change the Entity name i.e., if you have two Classes named the same thing but are in different packages.
20
21 Lets say you have a class named "School" in your model, but have defined the Entity name as "ERPSchool" you will always refer to it as "ERPSchool" when passing it in as a parameter. For example:
22
23 {{noformat}}
24 routeRequestHandler.addDefaultRoutes("ERPSchool"); // School.ENTITY_NAME
25 {{/noformat}}
26
27
28
29 Also, when naming your controller classes, you should use the Entity name.
30
31 {{noformat}}
32
33 public class ERPSchoolController extends ERXDefaultRouteController {
34 ...
35 School school = (School) routeObjectForKey("ERPSchool");
36
37 {{/noformat}}
38
39
40
41 If you want to call it "School" to the outside, add this before you register the default routes for "ERPSchool":
42
43
44 {{noformat}}
45
46 ERXRestNameRegistry.registry().setExternalNameForInternalName("School", "ERPSchool"); // "School", School.ENTITY_NAME
47
48 {{/noformat}}
49
50
51
52 After adding this, no other code changes. All you're saying is that the routes and type names that send over the wire should all say "School".
53
54 = WO HTTP adaptor =
55
56 The WO HTTP adaptor coming with WO 5.3 doesn't support PUT and DELETE operations, so you won't be able to use those two HTTP methods. You need to use either the 5.4 adaptor or the Wonder version of the adaptor.
57
58 = To-many relationships =
59
60 ERRest won't let you add or remove objects in a to-many relationship, it can only update an existing object that is in the relationship. To add a new object to a relationship, you first need to fetch (or create) the parent object and make a second call to create the object and add it to the relationship.
61
62 So let's say you have an existing Organization object and you want to add a Member to it. First, you need to fetch the Organization :
63
64 {{code}}
65
66 GET /cgi-bin/WebObjects/ra/Organization/1.json
67
68 {{/code}}
69
70 and after, you create a new Member :
71
72 {{code}}
73
74 POST /cgi-bin/WebObjects/ra/Organization/1/addMember.json
75
76 {{/code}}
77
78 = Same Origin policy =
79
80 If you are planning to offer your REST services to other people, they might run into Same Origin Policy problem. When using XMLHttpRequest on a page who is on a different domain than the REST service, XMLHttpRequest will tell you that it's not acceptable.
81
82 To get around that problem, many solutions has been found, but two of them are more accepted than the others : [[JSONP>>http://en.wikipedia.org/wiki/JSON#JSONP]] and [[HTTP//access//control>>https://developer.mozilla.org/en/HTTP_access_control]]. I didn't try the JSONP route, but I did try HTTP//access//control, and Dojo and Prototype are using this method to get around the Same Origin policy problem.
83
84 HTTP//access//control works by adding new headers in the request that says which HTTP methods the request wants to do, and it's send as a OPTIONS HTTP method. You MUST reply with some headers to this OPTIONS request. Support for those headers was added in ERRest somewhere in october 2010.
85
86 To enable the headers and support for the OPTIONS method, add this property:
87
88 {{code}}
89 ERXRest.accessControlAllowOrigin=*
90 {{/code}}
91
92 If you want to allow origin for only a specific host, change the value of the property to the IP or DNS name of the requester.
93
94 Now, sadly only newer (2008 or later) browsers support the HTTP Access Control standard. For older browsers, you have to support JSONP, or the [[window.name transport>>http://www.sitepen.com/blog/2008/07/22/windowname-transport/]]. JSONP is not integrated in JSONP, but you can use the window.name transport by enabling support with the following property.
95
96 {{code}}
97 ERXRest.allowWindowNameCrossDomainTransport=true
98 {{/code}}
99
100 == Dates ==
101
102 The default formatter for dates is :
103
104 {{code}}
105
106 %Y-%m-%dT%H:%M:%SZ
107
108 {{/code}}
109
110 If you want to work with the the GMT offset, you have to use this instead :
111
112 {{code}}
113
114 %Y-%m-%dT%H:%M:%S%z
115
116 {{/code}}
117
118 To change it, you have to set the "er.rest.timestampFormat" property :
119
120 {{code}}
121
122 er.rest.timestampFormat = %Y-%m-%dT%H:%M:%S%z
123
124 {{/code}}
125
126 If you are using Dojo, you can use dojo.date.stamp.toISOString and dojo.date.stamp.fromISOString to convert from or to a Java date object.
127
128 == JSON Schema support ==
129
130 ERRest have support for [[JSON Schema>>http://www.sitepen.com/blog/2008/10/31/json-schema/]] since october 2010. JSON Schema is like a mini-WSDL, where it describe which properties JSON objects have. Dojo use JSON Schema to perform client-side validation, which is cool because you can have some automatic validation based on your model, and validation is done even before the data is sent back to your REST service.
131
132 To get the schema, you need to check in your route action. For example, for the "index" action, you do:
133
134 {{code}}
135
136 public WOActionResults indexAction() throws Throwable {
137 if (isSchemaRequest()) {
138 return schemaResponse(yourERXKeyFilter());
139 }
140 ... do your normal work here
141 }
142
143 {{/code}}
144
145 And you call your REST route, but by adding "?schema=true" at the end of the URL. For example, ///ra/events.json?schema=true//. When you do that, a JSON Schema will be returned. Sample:
146
147 {{code}}
148
149 {
150 "name":"Event",
151 "properties":{
152 "isFullDay":{
153 "optional":true,
154 "type":"string",
155 "maxLength":5
156 },
157 "startDate":{
158 "optional":false,
159 "type":"string",
160 "format":"date-time"
161 },
162 "realDuration":{
163 "optional":true,
164 "type":"integer"
165 }
166 }
167 }
168
169 {{/code}}
170
171 So when you create a new Event with Dojo, if you try to put something else than a date in startDate, or you put a string in realDuration, it will fail because the schema says that startDate is using the date-time format, and that realDuration is a integer.