ERRest In Depth

RestEntitiesController(ERXRouteController).performRouteActionNamed -> RestEntitiesController(ERXRouteController).performActionWithArguments(Method, Object...) ->

28

Method.invoke -> ...

29

RestEntitiesController.indexAction()

performActionNamed:

if (transactionAdaptor.transactionsEnabled() && !transactionAdaptor.isExecutingTransaction(context(), request())) {

39

if (!transactionAdaptor.willHandleRequest(context(), request())) {

40

if (transactionAdaptor.didHandleRequest(context(), request())) {

41

results = stringResponse("Transaction request enqueued.");

42

} else {

43

results = stringResponse("Transaction executed.");

}

}

}

if (results == null) {

checkAccess();

}

if (results == null && isAutomaticHtmlRoutingEnabled() && format() == ERXRestFormat.html()) {

53

results = performHtmlActionNamed(actionName);

54

}

55

56

if (results == null) {

57

results = performRouteActionNamed(actionName);

58

}

59

60

if (results == null) {

61

results = response(null, ERXKeyFilter.filterWithAttributes());

62

}

63

else if (results instanceof IERXRouteComponent) {

64

_takeRouteParametersFromRequest(results);

}

checkAccess:

protected void checkAccess() throws SecurityException {

}

ERXRestUtils

request > route

/**

* A NameFormat that behaves like Rails -- plural entities, plural routes, lowercase underscore names

86

* (names_like_this).

87

*/

88

public static NameFormat RAILS = new NameFormat(true, true, NameFormat.Case.LowercaseUnderscore);

89

90

/**

91

* A NameFormat that behaves like WO -- singular entities, singular routes, camel names (NamesLikeThis).

92

*/

93

public static NameFormat WO = new NameFormat(false, false, NameFormat.Case.CamelCase);

94

95

/**

96

* A NameFormat that behaves like WO -- singular entities, singular routes, lowercase camel names (namesLikeThis).

97

*/

98

public static NameFormat WO_LOWER = new NameFormat(false, false, NameFormat.Case.LowerCamelCase);

* ERXRestContext

** contains the editing context and an userInfo dictionnary

104

** will be populated with er.rest.dateFormat, er.rest.timestampFormatter and er.rest.timestampFormat (read only for non-HTML responses)

105

*** want to change the time format for a specific controller?

protected ERXRestContext createRestContext() {

110

ERXRestContext restContext = new ERXRestContext(editingContext());

111

restContext.setUserInfoForKey("yyyy-MM-dd", "er.rest.dateFormat");

112

restContext.setUserInfoForKey("yyyy-MM-dd", "er.rest.timestampFormat");

return restContext;

}

*

** you just need to override createRestContext() in your controller if you want to add other stuff to the context (a user, etc.)

120

* Properties

121

** ERXRest.idKey (ERXRestFormatDelegate)

122

*** (default "id") Override this property if you want to use a different key for the 'id' attribute** ERXRest.typeKey**

123

** ERXRest.nilKey (ERXRestFormatDelegate)

124

** ERXRest.writeNilKey (ERXRestFormatDelegate)

125

** ERXRest.pluralEntityNames (ERXRestFormatDelegate)

126

** ERXRest.writeTypeKey (ERXRestFormatDelegate)

127

** ERXRest.suppressTypeAttributesForSimpleTypes (ERXXmlRestWriter)

128

*** (default "false") If set to true, primitive types, like type = "datetime", won't be added to the output

129

** ERXRest.strictMode

130

*** 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

131

*** 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

132

*** ERXRouteResults: (default "true") If set to true, creating a ressource will return status code 201 Created, if set to false, will return 200 OK

133

** ERXRest.pluralEntityNames (ERXRouteRequestHandler)

134

** ERXRest.routeCase (ERXRouteRequestHandler)

135

** ERXRest.lowercaseEntityNames (ERXRouteRequestHandler)

136

** ERXRest.parseUnknownExtensions (ERXRouteRequestHandler)

137

*** (default "true") If set to "false", will return a 404 status code if the format doesn't exist

138

** ERXRest.missingControllerName (ERXRouteRequestHandler)

139

*** (default "ERXMissingRouteController") Allow you to specify which controller to use when a route doesn't exist

140

** er.rest.rfcDateFormat

141

** er.rest.dateFormat

142

** er.rest.dateFormat.primary

143

** er.rest.dateFormat.secondary

144

** er.rest.dateFormatter

145

** er.rest.timestampFormat

146

** er.rest.timestampFormat.primary

147

** er.rest.timestampFormat.secondary

148

** er.rest.timestampFormatter

149

** er.rest.rfcDateFormat

150

** er.rest.jodaTime

151

** ERXRest.transactionsEnabled (default 'false') ERXRestTransactionRequestAdaptor

152

** ERXRest.maxEventsPerTransaction (default '50') ERXRestTransactionRequestAdaptor

153

** ERXRest.accessControlAllowRequestHeaders (ERXRouteController)

154

** ERXRest.accessControlAllowRequestMethods (ERXRouteController)

155

** ERXRest.defaultFormat (ERXRouteController)

156

*** (default "xml") Allow you to set the default format for all of your REST controllers

157

** ERXRest.allowWindowNameCrossDomainTransport (ERXRouteController)

158

** ERXRest.accessControlMaxAge (ERXRouteController)

159

*** (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.

160

** ERXRest.accessControlAllowOrigin (ERXRouteController)

161

*** Set the value to '**' to enable all origins. See [[https://developer.mozilla.org/En/HTTP_access_control#Access-Control-Allow-Origin]]**

162

* JSON Schema

163

** {{code}}

164

/something?schema=true

165

166