Changes for page Your First Rest Project

Last modified by Steve Peery on 2013/09/06 11:02

From 32.1 to 33.1 From 34.1 to 35.1

From version 33.1

edited by Pascal Robert
on 2011/12/27 13:14

Change comment: There is no comment for this version

To version 34.1

edited by franc
on 2012/02/27 16:47

Change comment: replaced left > right

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.probert
++XWiki.franc

Content

@@ -24,7 +24,6 @@
  | id | integer | primary key
  | title | string(255) |
  | content | string(4000) |
--| lastModified | timestamp |
  | creationDate | timestamp |
  | author | integer | relation with Author
@@ -35,7 +35,6 @@
  | firstName | string(50) |
  | lastName | string(50) |
  | email | string(100) | unique
--| passwd | string(16) |
  == Creating the EOModel ==
@@ -75,7 +75,6 @@
  |= Attribute name |= Column |= Prototype
  | content | content | longtext
--| lastModified | lastModified | dateTime
  | creationDate | creationDate | dateTime
  If you did everything well, the list of attributes should look like this:
@@ -88,28 +88,350 @@
  | firstName | firstName | varchar50
  | lastName | lastName | varchar50
  | email | email | varchar100
--| passwd | passwd | varchar16
  Final list of attributes should look like this:
--Now, it's time to link the two entities together. A Author can have multiple blog entries, and a BlogEntry can only have one author. To create the relationship (the join), right-click on **Author** and select **New Relationship**. On your right, select **BlogEntry** in the list. On your left, select **to many BlogEntries**, and on your left, select **to one Author**. Now, in BlogEntry, we need to store the primary key of the author so that we can make the join. The relationship builder allow us to add that attribute, so make sure **and a new foreign key named** is checked (it is checked by default). The **Create Relationship** pane should look like this:
++Now, it's time to link the two entities together. A Author can have multiple blog entries, and a BlogEntry can only have one author. To create the relationship (the join), right-click on **Author** and select **New Relationship**. On your right, select **BlogEntry** in the list. On your left, select **to many BlogEntries**, and on your right, select **to one Author**. Now, in BlogEntry, we need to store the primary key of the author so that we can make the join. The relationship builder allow us to add that attribute, so make sure **and a new foreign key named** is checked (it is checked by default). The **Create Relationship** pane should look like this:
--If you check in the **Outline** tab, you should see that **Author** now have a **blogEntries** relationship, and **BlogEntry** have a **author** relationship.
++If you check in the **Outline** tab, you should see that **Author** now have a **blogEntries** relationship, and **BlogEntry** have a **author** relationship.
--You are now ready to save the model. Save it (File -> Save) and close the **Entity Modeler** window. If you open the **Sources** in the main Eclipse window, you will notice that the **Sources** folder contains a package named **your.app.model**.
++You are now ready to save the model. Save it (File > Save) and close the **Entity Modeler** window. If you open the **Sources** in the main Eclipse window, you will notice that the **Sources** folder contains a package named **your.app.model**.
--That package have four Java classes: **//Author//**//, **Author**, //**BlogEntry** and **BlogEntry**. Those classes were generated by Veogen, a templating engine build on Velocity. The two classes that starts with a underscore are recreated every time you change the EOModel, so if you want to change something in those classes, you need to change the template (no need for that right now). But you can change freely the two classes that don't have the underscore, and this is what we will be doing.
++That package have four Java classes: **Author**, **Author**, **BlogEntry** and **BlogEntry**. Those classes were generated by Veogen, a templating engine build on Velocity. The two classes that starts with a underscore are recreated every time you change the EOModel, so if you want to change something in those classes, you need to change the template (no need for that right now). But you can change freely the two classes that don't have the underscore, and this is what we will be doing.
  What we are going to do is to write a simple method that returns the full name of an author, e.g. a method that simply concatenate the first name, a space and the last name of the author. To do so, double-click on **Author.java** and add the following methods:
  {{code}}
--	public String fullName() {
++public String fullName() {
  	  return this.firstName() + " " + this.lastName();
  	}
  {{/code}}
--Nothing fancy here. And you are now ready to create REST controllers.
++Nothing fancy here. Now open **BlogEntry.java** and add the following method:
++{{code}}
++
++@Override
++	public void awakeFromInsertion(EOEditingContext editingContext) {
++	  super.awakeFromInsertion(editingContext);
++	  this.setCreationDate(new NSTimestamp());
++	}
++
++{{/code}}
++
++Why are we adding this? **awakeFromInsertion** is a very good way of setting default values when creating a new instance of a Enterprise Object (EO). In this case, we want to set automatically the creation date without having the user to add that value.
++
++Now, let's use migrations to actually create the database.
++
++== Using migrations ==
++
++Migrations allow you to create the tables and columns (and some types of constraint). **Entity Modeler** have support to generate the code for the first migration, which is called "migration 0". To do that, open the EOModel (**BlogModel EOModel** in the **Resources** folder), right-click on the model name and select **Generate Migration**.
++
++Copy the generated code in the clipboard. Close **Entity Modeler** and in the main Eclipse window, right-click on **Sources**, select **New** and select **Class**.
++
++Type **your.app.model.migrations** as the package and **BlogModel0** as the name of the class. Click **Finish**.
++
++In the **Sources** folder, open the **your.app.model.migrations** package, a class named **BlogModel0** should be there. Delete everything in that file **EXCEPT** the first line (which should be //package your.app.model.migrations//) and paste the code that was generated by **Entity Modeler**. Save the file.
++
++One last step: migrations are disabled by default. To enable them, you need to uncomment two properties in the **Properties** file that is located in the **Resources** folder. Open that file (double-click on it).
++
++Remove the pound char in front of those two properties:
++
++{{code}}
++
++#er.migration.migrateAtStartup=true
++#er.migration.createTablesIfNecessary=true
++
++{{/code}}
++
++After removing the pound char, the two properties should look like this:
++
++{{code}}
++
++er.migration.migrateAtStartup=true
++er.migration.createTablesIfNecessary=true
++
++{{/code}}
++
++You are now ready to start the application so that it creates the database To do so, right-click on **Application.java** (in the **your.app** folder) and select **Run As** > **WOApplication**. In Eclipse's Console tab, you should see some output, including something similar to:
++
++{{code}}
++
++BlogRest[62990] INFO  er.extensions.migration.ERXMigrator  - Upgrading BlogModel to version 0 with migration 'your.app.model.migrations.BlogModel0@4743bf3d'
++BlogRest[62990] INFO  er.extensions.jdbc.ERXJDBCUtilities  - Executing CREATE TABLE Author(email VARCHAR(100) NOT NULL, firstName VARCHAR(50) NOT NULL, id INTEGER NOT NULL, lastName VARCHAR(50) NOT NULL)
++BlogRest[62990] INFO  er.extensions.jdbc.ERXJDBCUtilities  - Executing ALTER TABLE Author ADD PRIMARY KEY (id)
++BlogRest[62990] INFO  er.extensions.jdbc.ERXJDBCUtilities  - Executing CREATE TABLE BlogEntry(authorID INTEGER NOT NULL, content TIMESTAMP NOT NULL, creationDate TIMESTAMP NOT NULL, id INTEGER NOT NULL, title VARCHAR(255) NOT NULL)
++BlogRest[62990] INFO  er.extensions.jdbc.ERXJDBCUtilities  - Executing ALTER TABLE BlogEntry ADD PRIMARY KEY (id)
++BlogRest[62990] INFO  er.extensions.jdbc.ERXJDBCUtilities  - Executing ALTER TABLE BlogEntry ADD CONSTRAINT "FOREIGN_KEY_BLOGENTRY_AUTHORID_AUTHOR_ID" FOREIGN KEY (authorID) REFERENCES Author (id)
++BlogRest[62990] DEBUG NSLog  -  evaluateExpression: <er.h2.jdbcadaptor.ERH2PlugIn$H2Expression: "UPDATE _dbupdater SET version = ? WHERE modelname = ?" withBindings: 1:0(version), 2:"BlogModel"(modelName)>
++
++{{/code}}
++
++If you see this and that the application is running (it should open a window in your favorite browser), migration worked and your database have been created, congratulations You can now stop the application (click the square red button in Eclipse's Console tab) and continue to the next step.
++
  = Creating REST controllers and routes =
++
++Project Wonder contains a framework called ERRest, which follow the same patterns as Ruby on Rails REST concepts. Using REST-style URLs is perfect for building a public blog and to create REST services to manage posting over HTTP with JSON, XML or other formats.
++
++By default, a REST route in ERRest will generate a link like this:
++
++{{code}}
++/cgi-bin/WebObjects/AppName.woa/ra/EntityName/id
++{{/code}}
++
++So for our case, to get the first blog posting from BlogRest, the URL will look like this:
++
++{{code}}
++/cgi-bin/WebObjects/BlogRest.woa/ra/blogEntries/1.html
++{{/code}}
++
++{{info}}
++You can shorten the URL by using mod_rewrite in Apache httpd
++{{/info}}
++
++== Creating controllers ==
++
++ERRest needs controllers to act as a broker between working with the objects and the routes. So let's create a controller for BlogEntry.
++
++Create a Java class named **BlogEntryController**, in the **your.app.rest.controllers** package, that will extend from **er.rest.routes.ERXDefaultRouteController**. Click **Finish**.
++
++When you extend from **ERXDefaultRouteController**, a bunch of methods are added to the subclass. Let's see what they are for.
++
++* **updateAction**: to update a specific instance of BlogEntry
++* **destroyAction**: to delete a specific instance of BlogEntry
++* **showAction**: to get one specific instance of BlogEntry
++* **createAction**: to create a new object (a new instance of BlogEntry)
++* **indexAction**: to list all (or a sublist) of the objects.
++
++{{info}}
++In Project Wonder, *Action* at the end of a method is a convention for REST and Direct Actions, when you call those methods from certain components, you don't need to add the *Action* part.
++{{/info}}
++
++For this tutorial, we will implement the **createAction** and **showAction** methods. But first, we need to create a key filter. A key filter will... filter the input and the output of REST request so that you don't have to send all attributes for a blog entry. For example, we want to show the details for an author, but we don't want to show the password for the author (in real-life, the password would be encrypted)
++
++Add this method in **BlogEntryController**:
++
++{{code}}
++
++protected ERXKeyFilter filter() {
++    ERXKeyFilter personFilter = ERXKeyFilter.filterWithAttributes();
++    personFilter.setAnonymousUpdateEnabled(true);
++
++    ERXKeyFilter filter = ERXKeyFilter.filterWithAttributes();
++    filter.include(BlogEntry.AUTHOR, personFilter);
++    filter.setUnknownKeyIgnored(true);
++
++    return filter;
++  }
++
++{{/code}}
++
++Now, let's implement the **creationAction** method:
++
++{{code}}
++
++public WOActionResults createAction() throws Throwable {
++    BlogEntry entry = create(filter());
++    editingContext().saveChanges();
++    return response(entry, filter());
++  }
++
++{{/code}}
++
++In 3 lines of code, you can create an object based on the request, save the new object to the database and return the new object in the response. Not bad, eh?
++
++Last step in the controller: implementing the **showAction** method. Again, the code is simple:
++
++{{code}}
++
++public WOActionResults indexAction() throws Throwable {
++    NSArray<BlogEntry> entries = BlogEntry.fetchAllBlogEntries(editingContext());
++    return response(entries, filter());
++  }
++
++{{/code}}
++
++That code simply fetch all blog entries and return them in the response.
++
++We can now go to the next step: adding the routes.
++
++== Adding the routes ==
++
++A route in ERRest is simply a way to define the URL for the entities and to specify which controller the route should use. When your controller extends from **ERXDefaultRouteController**, it's easy to register a controller and a route. In **Application.java**, in the **Application** constructor, add the following code:
++
++{{code}}
++
++ERXRouteRequestHandler restRequestHandler = new ERXRouteRequestHandler();
++    restRequestHandler.addDefaultRoutes(BlogEntry.ENTITY_NAME);
++    ERXRouteRequestHandler.register(restRequestHandler);
++    setDefaultRequestHandler(restRequestHandler);
++
++{{/code}}
++
++The **addDefaultRoutes** method do all of the required magic, and use convention. That's why we had to name the controller **BlogEntryController**, because the convention is <EntityName>Controller.
++
++We are now reading to add and list blog postings Start the application and take notice of the URL. It should be something like //[[http:~~/~~/yourip:someport/cgi-bin/WebObjects/BlogRest.woa>>http://yourip:someport/cgi-bin/WebObjects/BlogRest.woa_]]//
++
++== Adding posts and authors with curl ==
++
++Since we didn't implement any HTML for our REST routes, we will create blog entries with //curl//, an open source HTTP client that is bundled with Mac OS X (you can use another client, like wget, if you like too). So let's create a blog entry.
++
++To create a blog entry, you need to use the POST HTTP method. We will use JSON as the format since it's a bit less chatty than XML. So if the URL to the application is //[[http:~~/~~/192.168.0.102:52406/cgi-bin/WebObjects/BlogRest.woa>>http://192.168.0.102:52406/cgi-bin/WebObjects/BlogRest.woa_]], the full curl// command will be:
++
++{{code}}
++curl -X POST -v -d '{ "title": "First post", "content": "Some text", "author": { "firstName": "Pascal", "lastName": "Robert", "email": "probert@macti.ca"  } }' http://192.168.0.102:52406/cgi-bin/WebObjects/BlogRest.woa/ra/blogEntries.json
++{{/code}}
++
++The response should look this:
++
++{{code}}
++
++HTTP/1.0 201 Apple WebObjects
++Content-Length: 249
++x-webobjects-loadaverage: 0
++Content-Type: application/json
++
++{"id":1,"type":"BlogEntry","content":"Some text","creationDate":"2011-12-27T21:59:08Z","title":"First post","author":{"id":1,"type":"Author","email":"probert@macti.ca","firstName":"Pascal","lastName":"Robert"}}
++
++{{/code}}
++
++To get a list of blog entries:
++
++{{code}}
++
++curl -X GET http://192.168.0.102:52406/cgi-bin/WebObjects/BlogRest.woa/ra/blogEntries.json
++
++{{/code}}
++
++You can stop the application and proceed to the next step.
++
++== Adding HTML views for blog posts ==
++
++Now, let's build a HTML view for blog posts (you don't want your readers to get your posts by JSON, right?). Again, we will use convention to make it work easily. Open up **BlogEntryController** and add the following method:
++
++{{code}}
++
++@Override
++  protected boolean isAutomaticHtmlRoutingEnabled() {
++    return true;
++  }
++
++{{/code}}
++
++Switching the return value of this method says that we will follow a certain convention for HTML components. The convention for automatic HTML routing is that the component should be named <EntityName><Action>Page.wo. So in our case, the component will be **BlogEntryIndexPage**. Right-click on the project name in Eclipse and select **New** > **WOComponent**. Change the name to **BlogEntryIndexPage** and check the **Create HTML contents** button. Click **Finish**.
++
++The next step to get it to work is to make **BlogEntryIndexPage** to implements the **er.rest.routes.IERXRouteComponent** interface.
++
++{{code}}
++
++import er.rest.routes.IERXRouteComponent;
++
++public class BlogEntryIndexPage extends WOComponent implements IERXRouteComponent {
++
++{{/code}}
++
++So now, the automatic HTML routing will send the request for **ra/blogEntries.html** to the **BlogEntryIndexPage** component. But we don't have any content in this component, so let's make a method to fetch all blog entries per creation date in descending order. So in **BlogEntryIndexPage.java**, add the following method:
++
++{{code}}
++
++public NSArray<BlogEntry> entries() {
++      EOEditingContext ec = ERXEC.newEditingContext();
++      return BlogEntry.fetchAllBlogEntries(ec, BlogEntry.CREATION_DATE.descs());
++    }
++
++{{/code}}
++
++We need to use that method in a WORepetition, and for that loop, we need a BlogEntry variable to iterate in the list, so add the following code to **BlogEntryIndexPage.java**:
++
++{{code}}
++
++private BlogEntry entryItem;
++
++    public BlogEntry entryItem() {
++      return entryItem;
++    }
++
++    public void setEntryItem(BlogEntry entryItem) {
++      this.entryItem = entryItem;
++    }
++
++{{/code}}
++
++The Java part is done, so let's add the loop inside the component. Open **BlogEntryIndexPage.wo** (it's located in the **Component** folder) and right after the <body> tag, add:
++
++{{code}}
++
++<wo:loop list="$entries" item="$entryItem">
++      <p><wo:str value="$entryItem.title" /></p>
++      <p><wo:str value="$entryItem.author.fullName" /></p>
++    </wo:loop>
++
++{{/code}}
++
++That component code will loop over the blog entries and display the title of the entry + the name of the author. Save everything and run the application.
++
++If you go to [[http://192.168.0.102:52406/cgi-bin/WebObjects/BlogRest.woa/ra/blogEntries.html]], you will see the list of blog entries
++
++Now that we have a list of blog entries, let's make a page to show the content of a blog entry. Create a new component named **BlogEntryShowPage**.
++
++Open **BlogEntryShowPage.java** and make sure the class extends from **er.rest.routes.IERXRouteComponent**.
++
++{{code}}
++
++import er.rest.routes.IERXRouteComponent;
++
++public class BlogEntryShowPage extends WOComponent implements IERXRouteComponent {
++
++{{/code}}
++
++We need to add other methods to receive the BlogEntry object from the controller. In **BlogEntryShowPage.java**, add:
++
++{{code}}
++
++private BlogEntry blogEntry;
++
++    @ERXRouteParameter
++    public void setBlogEntry(BlogEntry blogEntryFromController) {
++      this.blogEntry = blogEntryFromController;
++    }
++
++    public BlogEntry blogEntry() {
++      return this.blogEntry;
++    }
++
++{{/code}}
++
++The **@ERXRouteParameter** annotation tells the REST framework that it can automatically receive an object from the controller. And again, it's convention at work. You have to use the annotation and the setter name should be //set<EntityName>//, so for a BlogEntry, it's //setBlogEntry//, for a Author, it will be //setAuthor//.
++
++The Java part of the work is done, so save the Java class. It's time to work on the component part. Open **BlogEntryShowPage.wo** and between the <body></body> part, add:
++
++{{code}}
++
++<h1><wo:str value="$blogEntry.title" /></h1>
++    <p><wo:str value="$blogEntry.content" /></p>
++    <p>Created on: <wo:str value="$blogEntry.creationDate" dateformat="%Y/%m/%d" /></p>
++    <p>Added by: <wo:str value="$blogEntry.author.fullName" /></p>
++
++{{/code}}
++
++Our view component is done, the only thing remaining is a link for the blog entry list (BlogEntryIndexPage) to the view page (BlogEntryShowPage). Save **BlogEntryShowPage.wo** and open **BlogEntryIndexPage.wo**. We are going to add a link on the title, you will replace to replace this:
++
++{{code}}
++
++<p><wo:str value="$entryItem.title" /></p>
++
++{{/code}}
++
++with:
++
++{{code}}
++
++<p><wo:ERXRouteLink entityName="BlogEntry" record="$entryItem" action="show"><wo:str value="$entryItem.title" /></wo:ERXRouteLink></p>
++
++{{/code}}
++
++Save the component and run the app. Go to [[http://192.168.0.102:52406/cgi-bin/WebObjects/BlogRest.woa/ra/blogEntries.html]] to get the list of posts, and you should see a link on the title. Click on it, and now you get the full details of the blog entry
++
++The REST part of this tutorial is now complete, you can now switch to the next part of the tutorial.

Changes for page Your First Rest Project

Summary

Details

Applications

Navigation

My Recent Modifications

Need help?