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())) {

38

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

39

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

40

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

41

} else {

42

results = stringResponse("Transaction executed.");

}

}

}

if (results == null) {

checkAccess();

}

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

52

results = performHtmlActionNamed(actionName);

53

}

54

55

if (results == null) {

56

results = performRouteActionNamed(actionName);

57

}

58

59

if (results == null) {

60

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

61

}

62

else if (results instanceof IERXRouteComponent) {

63

_takeRouteParametersFromRequest(results);

}

ERXRouteController.checkAccess()

69

70

Will do nothing by default. Override it to check for security.

protected void checkAccess() throws SecurityException {

}

ERXRouteController.performHtmlActionNamed

80

81

82

protected WOActionResults performHtmlActionNamed(String actionName) throws Exception {

83

WOActionResults results = null;

84

85

String pageName = pageNameForAction(actionName);

86

if (_NSUtilities.classWithName(pageName) != null) {

87

try {

88

results = pageWithName(pageName);

89

if (!(results instanceof IERXRouteComponent)) {

90

log.error(pageName + " does not implement IERXRouteComponent, so it will be ignored.");

results = null;

}

}

catch (WOPageNotFoundException e) {

95

log.info(pageName + " does not exist, falling back to route controller.");

results = null;

}

}

else {

log.info(pageName + " does not exist, falling back to route controller.");

101

}

102

103

if (results == null && shouldFailOnMissingHtmlPage()) {

104

results = performUnknownAction(actionName);

}

return results;

}

protected String pageNameForAction(String actionName) {

113

return entityName() + ERXStringUtilities.capitalize(actionName) + "Page";

}

protected boolean shouldFailOnMissingHtmlPage() {

return false;

}

ERXRestUtils

request -> route

/**

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

133

* (names_like_this).

134

*/

135

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

136

137

/**

138

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

139

*/

140

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

141

142

/**

143

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

144

*/

145

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

* ERXRestContext

** contains the editing context and an userInfo dictionnary

151

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

152

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

153

** {{code}}

154

protected ERXRestContext createRestContext() {

155

ERXRestContext restContext = new ERXRestContext(editingContext());

156

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

157

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

158

return restContext;

159

}

160

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

161

* Properties

162

** ERXRest.idKey (ERXRestFormatDelegate)

163

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

164

** ERXRest.nilKey (ERXRestFormatDelegate)

165

** ERXRest.writeNilKey (ERXRestFormatDelegate)

166

** ERXRest.pluralEntityNames (ERXRestFormatDelegate)

167

** ERXRest.writeTypeKey (ERXRestFormatDelegate)

168

** ERXRest.suppressTypeAttributesForSimpleTypes (ERXXmlRestWriter)

169

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

170

** ERXRest.strictMode

171

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

172

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

173

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

174

** ERXRest.pluralEntityNames (ERXRouteRequestHandler)

175

** ERXRest.routeCase (ERXRouteRequestHandler)

176

** ERXRest.lowercaseEntityNames (ERXRouteRequestHandler)

177

** ERXRest.parseUnknownExtensions (ERXRouteRequestHandler)

178

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

179

** ERXRest.missingControllerName (ERXRouteRequestHandler)

180

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

181

** er.rest.rfcDateFormat

182

** er.rest.dateFormat

183

** er.rest.dateFormat.primary

184

** er.rest.dateFormat.secondary

185

** er.rest.dateFormatter

186

** er.rest.timestampFormat

187

** er.rest.timestampFormat.primary

188

** er.rest.timestampFormat.secondary

189

** er.rest.timestampFormatter

190

** er.rest.rfcDateFormat

191

** er.rest.jodaTime

192

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

193

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

194

** ERXRest.accessControlAllowRequestHeaders (ERXRouteController)

195

** ERXRest.accessControlAllowRequestMethods (ERXRouteController)

196

** ERXRest.defaultFormat (ERXRouteController)

197

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

198

** ERXRest.allowWindowNameCrossDomainTransport (ERXRouteController)

199

** ERXRest.accessControlMaxAge (ERXRouteController)

200

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

201

** ERXRest.accessControlAllowOrigin (ERXRouteController)

202

*** Set the value to '*' to enable all origins. See [[https:~~/~~/developer.mozilla.org/En/HTTP_access_control#Access-Control-Allow-Origin>>url:https://developer.mozilla.org/En/HTTP_access_control#Access-Control-Allow-Origin||shape="rect"]]

* JSON Schema

**

/something?schema=true

209

210

public WOActionResults indexAction() {