Skip to Content

Changes for page ERRest In Depth

Last modified by Pascal Robert on 2012/06/10 16:01
From version 41.1
edited by Pascal Robert
on 2012/06/10 15:08
Change comment: There is no comment for this version
To version 37.1
edited by Pascal Robert
on 2012/05/02 20:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,59 +57,3 @@
1 -General architecture
2 -Same Origin policy
3 -Transactions
4 -HTML vs other formats
5 -Response representation
6 -Missing route
7 -Missing object
8 -POJO objects
9 -Headers
10 -Caching
11 -Adding new format
12 -Security
13 -strictMode
14 -Workflow
15 -Query arguments and RXRestFetchSpecification
16 -ERXRestNameRegistry
17 -MapClassDescription / NSDictionaryClassDescription
18 -
19 -Calling an action goes like this:
20 -
21 -{{code}}
22 -
23 -Application.dispatchRequest ->
24 -ERXRouteRequestHandler.handleRequest ->
25 -ERXRouteRequestHandler._handleRequest ->
26 -RestEntitiesController(ERXRouteController).performActionNamed ->
27 -RestEntitiesController(ERXRouteController).performRouteActionNamed -> RestEntitiesController(ERXRouteController).performActionWithArguments(Method, Object...) ->
28 -Method.invoke -> ...
29 -RestEntitiesController.indexAction()
30 -
31 -{{/code}}
32 -
33 -ERXRestUtils
34 -
35 -request > route
36 -
37 -{{code}}
38 -
39 -/**
40 - * A NameFormat that behaves like Rails -- plural entities, plural routes, lowercase underscore names
41 - * (names_like_this).
42 - */
43 - public static NameFormat RAILS = new NameFormat(true, true, NameFormat.Case.LowercaseUnderscore);
44 -
45 - /**
46 - * A NameFormat that behaves like WO -- singular entities, singular routes, camel names (NamesLikeThis).
47 - */
48 - public static NameFormat WO = new NameFormat(false, false, NameFormat.Case.CamelCase);
49 -
50 - /**
51 - * A NameFormat that behaves like WO -- singular entities, singular routes, lowercase camel names (namesLikeThis).
52 - */
53 - public static NameFormat WO_LOWER = new NameFormat(false, false, NameFormat.Case.LowerCamelCase);
54 -
55 -{{/code}}
56 -
57 57  * ERXRestContext
58 58  ** contains the editing context and an userInfo dictionnary
59 59  ** will be populated with er.rest.dateFormat, er.rest.timestampFormatter and er.rest.timestampFormat (read only for non-HTML responses)
... ... @@ -74,17 +74,13 @@
74 74  ** you just need to override createRestContext() in your controller if you want to add other stuff to the context (a user, etc.)
75 75  * Properties
76 76  ** ERXRest.idKey (ERXRestFormatDelegate)
77 -*** (default "id") Override this property if you want to use a different key for the 'id' attribute** ERXRest.typeKey**
21 +*** (default "id") Override this property if you want to use a different key for the 'id' attribute ERXRest.typeKey
78 78  ** ERXRest.nilKey (ERXRestFormatDelegate)
79 79  ** ERXRest.writeNilKey (ERXRestFormatDelegate)
80 80  ** ERXRest.pluralEntityNames (ERXRestFormatDelegate)
81 81  ** ERXRest.writeTypeKey (ERXRestFormatDelegate)
82 -** ERXRest.suppressTypeAttributesForSimpleTypes (ERXXmlRestWriter)
83 -*** (default "false") If set to true, primitive types, like type = "datetime", won't be added to the output
26 +** ERXRest.suppressTypeAttributesForSimpleTypes
84 84  ** ERXRest.strictMode
85 -*** In ERXMissingRouteController: (default "true") If set to true, status code in the response will be 405 Not Allowed, if set to false, status code will be 404 Not Found
86 -*** In ERXRouteController: (default "true") If set to true, status code in the response will be 405 Not Allowed, if set to false, status code will be 404 Not Found
87 -*** ERXRouteResults: (default "true") If set to true, creating a ressource will return status code 201 Created, if set to false, will return 200 OK
88 88  ** ERXRest.pluralEntityNames (ERXRouteRequestHandler)
89 89  ** ERXRest.routeCase (ERXRouteRequestHandler)
90 90  ** ERXRest.lowercaseEntityNames (ERXRouteRequestHandler)
... ... @@ -102,18 +102,8 @@
102 102  ** er.rest.timestampFormat.secondary
103 103  ** er.rest.timestampFormatter
104 104  ** er.rest.rfcDateFormat
105 -** er.rest.jodaTime
106 -** ERXRest.transactionsEnabled (default 'false') ERXRestTransactionRequestAdaptor
107 -** ERXRest.maxEventsPerTransaction (default '50') ERXRestTransactionRequestAdaptor
108 -** ERXRest.accessControlAllowRequestHeaders (ERXRouteController)
109 -** ERXRest.accessControlAllowRequestMethods (ERXRouteController)
110 -** ERXRest.defaultFormat (ERXRouteController)
111 -*** (default "xml") Allow you to set the default format for all of your REST controllers
112 -** ERXRest.allowWindowNameCrossDomainTransport (ERXRouteController)
113 -** ERXRest.accessControlMaxAge (ERXRouteController)
114 -*** (default 1728000) This header indicates how long the results of a preflight request can be cached. For an example of a preflight request, see the above examples.
115 -** ERXRest.accessControlAllowOrigin (ERXRouteController)
116 -*** Set the value to '**' to enable all origins. See [[https://developer.mozilla.org/En/HTTP_access_control#Access-Control-Allow-Origin]]**
45 +** ERXRest.transactionsEnabled
46 +** ERXRest.maxEventsPerTransaction
117 117  * JSON Schema
118 118  ** {{code}}
119 119  /something?schema=true
... ... @@ -127,6 +127,31 @@
127 127  }
128 128  {{/code}}
129 129  
60 +Same Origin policy
61 +Transactions
62 +HTML vs other formats
63 +Response representation
64 +Missing route
65 +Missing object
66 +POJO objects
67 +Headers
68 +Caching
69 +Adding new format
70 +Security
71 +strictMode
72 +Workflow
73 +Query arguments and RXRestFetchSpecification
74 +ERXRestNameRegistry
75 +MapClassDescription / NSDictionaryClassDescription
76 +
77 +ERXRestUtils
78 +Properties
79 +er.rest.dateFormat
80 +er.rest.timestampFormat
81 +er.rest.rfcDateFormat
82 +
83 +request > route
84 +
130 130  Application(ERXApplication).dispatchRequest(WORequest) line: 2051
131 131  ERXRouteRequestHandler(WOActionRequestHandler).//handleRequest(WORequest) line: 221
132 132  ERXRouteRequestHandler.getRequestHandlerPathForRequest(WORequest) line: 782//
... ... @@ -158,3 +158,13 @@
158 158  | ERXRest.strictMode | ERXRest.strictMode
159 159  \\          |
160 160  ERXRouteController
116 +
117 +Properties
118 +
119 +ERXRest.accessControlAllowRequestHeaders
120 +ERXRest.accessControlAllowRequestMethods
121 +ERXRest.defaultFormat
122 +ERXRest.strictMode
123 +ERXRest.allowWindowNameCrossDomainTransport
124 +ERXRest.accessControlMaxAge
125 +ERXRest.accessControlAllowOrigin