From f0d1c25bdb8d5eb3ed5946efd494f8e3c16d2b97 Mon Sep 17 00:00:00 2001 From: Arseni Bulatski Date: Tue, 2 Apr 2019 16:16:35 +0300 Subject: [PATCH] Update tutorial to RESTful application. --- .../_getting-started-guide/webapp.adoc | 248 +++++------------- tutorials/pom.xml | 3 +- tutorials/tutorial/pom.xml | 22 +- .../tutorial/config/CayenneConfig.java} | 54 ++-- .../config/CayenneServerRuntimeFactory.java | 39 +++ .../tutorial/persistent/auto/_Artist.java | 18 ++ .../tutorial/persistent/auto/_Datamap.java | 18 ++ .../tutorial/persistent/auto/_Gallery.java | 18 ++ .../tutorial/persistent/auto/_Painting.java | 18 ++ .../cayenne/tutorial/pojo/ArtistPojo.java | 44 ++++ .../cayenne/tutorial/pojo/GalleryPojo.java | 34 +++ .../cayenne/tutorial/pojo/PaintingPojo.java | 34 +++ .../tutorial/resource/CayenneResource.java | 100 +++++++ .../tutorial/src/main/webapp/WEB-INF/web.xml | 71 +++-- tutorials/tutorial/src/main/webapp/detail.jsp | 89 ------- 15 files changed, 466 insertions(+), 344 deletions(-) rename tutorials/tutorial/src/main/{webapp/index.jsp => java/org/apache/cayenne/tutorial/config/CayenneConfig.java} (51%) create mode 100644 tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/config/CayenneServerRuntimeFactory.java create mode 100644 tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/ArtistPojo.java create mode 100644 tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/GalleryPojo.java create mode 100644 tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/PaintingPojo.java create mode 100644 tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/resource/CayenneResource.java delete mode 100644 tutorials/tutorial/src/main/webapp/detail.jsp diff --git a/docs/asciidoc/getting-started-guide/src/docs/asciidoc/_getting-started-guide/webapp.adoc b/docs/asciidoc/getting-started-guide/src/docs/asciidoc/_getting-started-guide/webapp.adoc index 32434a520a..8958658bd3 100644 --- a/docs/asciidoc/getting-started-guide/src/docs/asciidoc/_getting-started-guide/webapp.adoc +++ b/docs/asciidoc/getting-started-guide/src/docs/asciidoc/_getting-started-guide/webapp.adoc @@ -15,188 +15,104 @@ This chapter shows how to work with Cayenne in a web application. === Converting Tutorial to a Web Application -The web part of the web application tutorial is done in JSP, which is the least common -denominator of the Java web technologies, and is intentionally simplistic from the UI -perspective, to concentrate on Cayenne integration aspect, rather than the interface. A -typical Cayenne web application works like this: - -- Cayenne configuration is loaded when an application context is started, using a special servlet filter. -- User requests are intercepted by the filter, and the DataContext is bound to -the request thread, so the application can access it easily from anywhere. -- The same DataContext instance is reused within a single user session; -different sessions use different DataContexts (and therefore different sets of -objects). _The context can be scoped differently -depending on the app specifics. For the tutorial we'll be using a -session-scoped context._ +The web part of the web application tutorial is done as RESTful application. +A typical Cayenne web application works like this: + +- Cayenne configuration is loaded when an application context is started, using Jersey DI container. +- New ObjectContext is created for each request. So let's convert the tutorial that we created to a web application: +- First you need to create `CayenneServerRuntimeFactory` for injecting `ServerRuntime` to your service: + +.CayenneServerRuntimeFactory.java +[source,java] +---- +include::{java-include-dir}/config/CayenneServerRuntimeFactory.java[tag=content] +---- + +- Then create `CayenneConfig` what is the basis of the application: + +.CayenneConfig.java +[source,java] +---- +include::{java-include-dir}/config/CayenneConfig.java[tag=content] +---- + - In IDEA under "tutorial" project folder create a new folder `src/main/webapp/WEB-INF`. - Under `WEB-INF` create a new file `web.xml` (a standard web app descriptor): .web.xml [source,xml] ---- - - - - Cayenne Tutorial - - - - cayenne-project - org.apache.cayenne.configuration.web.CayenneFilter - - - cayenne-project - /* - - - index.jsp - + + Cayenne Rest Demo + + + Cayenne Rest Demo + org.glassfish.jersey.servlet.ServletContainer + + javax.ws.rs.Application + org.apache.cayenne.tutorial.config.CayenneConfig + + 1 + + + Cayenne Rest Demo + /cayenne/* + + ---- -- Create the artist browser page `src/main/webapp/index.jsp` file with the following contents: +- Next step is to create POJO classes for your entities. It will allow us to return JSON objects as responses. +For example POJO object for `Artist` might look like: -.webapp/index.jsp -[source,jsp] +.ArtistPojo.java +[source,java] ---- -<%@ page language="java" contentType="text/html" %> -<%@ page import="org.example.cayenne.persistent.*" %> -<%@ page import="org.apache.cayenne.*" %> -<%@ page import="org.apache.cayenne.query.*" %> -<%@ page import="org.apache.cayenne.exp.*" %> -<%@ page import="java.util.*" %> - -<% - ObjectContext context = BaseContext.getThreadObjectContext(); - List artists = ObjectSelect.query(Artist.class) - .orderBy(Artist.NAME.asc()) - .select(context); -%> - - - - Main - - -

Artists:

- - <% if(artists.isEmpty()) {%> -

No artists found

- <% } else { - for(Artist a : artists) { - %> -

<%=a.getName()%>

- <% - } - } %> -
-

Create new artist...

- - +include::{java-include-dir}/pojo/ArtistPojo.java[tag=content] ---- -- Create the artist editor page `src/main/webapp/detail.jsp` with the following content: +- Create POJOs for other entities. -.webapp/detail.jsp -[source,jsp] +- Finally you need to create resource class. + +.CayenneResource.java +[source,java] ---- -<%@ page language="java" contentType="text/html" %> -<%@ page import="org.example.cayenne.persistent.*" %> -<%@ page import="org.apache.cayenne.*" %> -<%@ page import="org.apache.cayenne.query.*" %> -<%@ page import="java.util.*" %> -<%@ page import="java.text.*" %> -<%@ page import="java.time.format.DateTimeFormatter" %> - -<% - ObjectContext context = BaseContext.getThreadObjectContext(); - String id = request.getParameter("id"); - - // find artist for id - Artist artist = null; - if(id != null && id.trim().length() > 0) { - artist = SelectById.query(Artist.class, Integer.parseInt(id)).selectOne(context); - } - - if("POST".equals(request.getMethod())) { - // if no id is saved in the hidden field, we are dealing with - // create new artist request - if(artist == null) { - artist = context.newObject(Artist.class); - } - - // note that in a real application we would so dome validation ... - // here we just hope the input is correct - artist.setName(request.getParameter("name")); - artist.setDateOfBirthString(request.getParameter("dateOfBirth")); - - context.commitChanges(); - - response.sendRedirect("index.jsp"); - } - - if(artist == null) { - // create transient artist for the form response rendering - artist = new Artist(); - } - - String name = artist.getName() == null ? "" : artist.getName(); - - DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyyMMdd"); - String dob = artist.getDateOfBirth() == null - ? "" :artist.getDateOfBirth().format(formatter); -%> - - - Artist Details - - -

Artists Details

-
- " /> - - - - - - - - - - - - - -
Name:
Date of Birth (yyyyMMdd):
-
- - +include::{java-include-dir}/resource/CayenneResource.java[tag=content] ---- ==== Running Web Application -We need to add cayenne-web module and javax servlet-api for our application. +We need to add jersey-container-servlet, jersey-hk2, jersey-media-json-jackson and +javax servlet-api for our application. .pom.xml [source,xml] ---- - org.apache.cayenne - cayenne-web - ${cayenne.version} + org.glassfish.jersey.containers + jersey-container-servlet + 2.28 + + + org.glassfish.jersey.inject + jersey-hk2 + 2.28 + + + org.glassfish.jersey.media + jersey-media-json-jackson + 2.28 javax.servlet javax.servlet-api - 3.1.0 + 4.0.1 provided ---- @@ -213,7 +129,7 @@ section and save the POM: org.eclipse.jetty jetty-maven-plugin - 9.4.8.v20171121 + 9.4.15.v20190215 @@ -255,32 +171,10 @@ like this: - So the Jetty container just started. -- Now go to http://localhost:8080/ URL. You should see "No artists found message" in the web browser and -the following output in the IDEA console: - - INFO: Loading XML configuration resource from file:/.../tutorial/target/classes/cayenne-project.xml - INFO: loading user name and password. - INFO: Connecting to 'jdbc:derby:memory:testdb;create=true' as 'null' - INFO: +++ Connecting: SUCCESS. - INFO: setting DataNode 'datanode' as default, used by all unlinked DataMaps - INFO: Detected and installed adapter: org.apache.cayenne.dba.derby.DerbyAdapter - INFO: --- transaction started. - INFO: No schema detected, will create mapped tables - INFO: CREATE TABLE GALLERY (ID INTEGER NOT NULL, NAME VARCHAR (200), PRIMARY KEY (ID)) - INFO: CREATE TABLE ARTIST (DATE_OF_BIRTH DATE, ID INTEGER NOT NULL, NAME VARCHAR (200), PRIMARY KEY (ID)) - INFO: CREATE TABLE PAINTING (ARTIST_ID INTEGER, GALLERY_ID INTEGER, ID INTEGER NOT NULL, - NAME VARCHAR (200), PRIMARY KEY (ID)) - INFO: ALTER TABLE PAINTING ADD FOREIGN KEY (ARTIST_ID) REFERENCES ARTIST (ID) - INFO: ALTER TABLE PAINTING ADD FOREIGN KEY (GALLERY_ID) REFERENCES GALLERY (ID) - INFO: CREATE TABLE AUTO_PK_SUPPORT ( - TABLE_NAME CHAR(100) NOT NULL, NEXT_ID BIGINT NOT NULL, PRIMARY KEY(TABLE_NAME)) - ... - INFO: SELECT t0.DATE_OF_BIRTH, t0.NAME, t0.ID FROM ARTIST t0 ORDER BY t0.NAME - INFO: === returned 0 rows. - took 17 ms. - INFO: +++ transaction committed. +- Now you can create new artist using `curl -X POST 'http://localhost:8080/cayenne/artist?name=Picasso&date=18811125'` -- You can click on "Create new artist" link to create artists. Existing artists can be edited by clicking on their name: +- Get all artists using `curl -X GET 'http://localhost:8080/cayenne/artists'` -image::chrome-webapp.png[align="center"] +- Modify artist by id using `curl -X PUT 'http://localhost:8080/cayenne/artist/200?name=NewName'` You are done with the tutorial! \ No newline at end of file diff --git a/tutorials/pom.xml b/tutorials/pom.xml index 377929cc8a..4244872fba 100644 --- a/tutorials/pom.xml +++ b/tutorials/pom.xml @@ -39,7 +39,8 @@ - 9.4.8.v20171121 + 9.4.15.v20190215 + 2.28 diff --git a/tutorials/tutorial/pom.xml b/tutorials/tutorial/pom.xml index 4966bad2ec..186c7d4a08 100644 --- a/tutorials/tutorial/pom.xml +++ b/tutorials/tutorial/pom.xml @@ -31,17 +31,27 @@ cayenne-server ${project.version} + + org.glassfish.jersey.containers + jersey-container-servlet + ${jersey.version} + + + org.glassfish.jersey.inject + jersey-hk2 + ${jersey.version} + + + org.glassfish.jersey.media + jersey-media-json-jackson + ${jersey.version} + javax.servlet javax.servlet-api - 3.1.0 + 4.0.1 provided - - org.apache.cayenne - cayenne-web - ${project.version} - org.apache.derby derby diff --git a/tutorials/tutorial/src/main/webapp/index.jsp b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/config/CayenneConfig.java similarity index 51% rename from tutorials/tutorial/src/main/webapp/index.jsp rename to tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/config/CayenneConfig.java index 915221b06c..defdc92922 100644 --- a/tutorials/tutorial/src/main/webapp/index.jsp +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/config/CayenneConfig.java @@ -1,4 +1,3 @@ - -<%@ page contentType="text/html" %> -<%@ page import="org.apache.cayenne.tutorial.persistent.*" %> -<%@ page import="org.apache.cayenne.*" %> -<%@ page import="org.apache.cayenne.query.*" %> -<%@ page import="java.util.*" %> + +package org.apache.cayenne.tutorial.config; + +import javax.ws.rs.ext.Provider; + +import org.glassfish.jersey.internal.inject.AbstractBinder; +import org.glassfish.jersey.server.ResourceConfig; + // tag::content[] -<% - ObjectContext context = BaseContext.getThreadObjectContext(); - List artists = ObjectSelect.query(Artist.class) - .orderBy(Artist.NAME.asc()) - .select(context); -%> - - - Main - - -

Artists:

- - <% if(artists.isEmpty()) {%> -

No artists found

- <% } else { - for(Artist a : artists) { - %> -

<%=a.getName()%>

- <% +@Provider +public class CayenneConfig extends ResourceConfig { + + public CayenneConfig() { + packages("org.apache.cayenne.tutorial.resource"); + register(new AbstractBinder() { + @Override + protected void configure() { + bindAsContract(CayenneServerRuntimeFactory.class); } - } %> -
-

Create new artist...

- - -// end::content[] \ No newline at end of file + }); + } +} +// end::content[] diff --git a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/config/CayenneServerRuntimeFactory.java b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/config/CayenneServerRuntimeFactory.java new file mode 100644 index 0000000000..ff4e84fb37 --- /dev/null +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/config/CayenneServerRuntimeFactory.java @@ -0,0 +1,39 @@ +/***************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + ****************************************************************/ + +package org.apache.cayenne.tutorial.config; + +import org.apache.cayenne.configuration.server.ServerRuntime; + +// tag::content[] +public class CayenneServerRuntimeFactory { + + private ServerRuntime serverRuntime; + + public CayenneServerRuntimeFactory() { + this.serverRuntime = ServerRuntime.builder() + .addConfig("cayenne-project.xml") + .build(); + } + + public ServerRuntime get() { + return serverRuntime; + } +} +// end::content[] diff --git a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Artist.java b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Artist.java index 5ff7823239..e56182acb4 100644 --- a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Artist.java +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Artist.java @@ -1,3 +1,21 @@ +/***************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + ****************************************************************/ package org.apache.cayenne.tutorial.persistent.auto; import java.io.IOException; diff --git a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Datamap.java b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Datamap.java index acb07cc777..a83235e19d 100644 --- a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Datamap.java +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Datamap.java @@ -1,3 +1,21 @@ +/***************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + ****************************************************************/ package org.apache.cayenne.tutorial.persistent.auto; diff --git a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Gallery.java b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Gallery.java index 0dfd941852..4bd1ea2a65 100644 --- a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Gallery.java +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Gallery.java @@ -1,3 +1,21 @@ +/***************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + ****************************************************************/ package org.apache.cayenne.tutorial.persistent.auto; import java.io.IOException; diff --git a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Painting.java b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Painting.java index e15e25f833..bd3ac05ce0 100644 --- a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Painting.java +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/persistent/auto/_Painting.java @@ -1,3 +1,21 @@ +/***************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + ****************************************************************/ package org.apache.cayenne.tutorial.persistent.auto; import java.io.IOException; diff --git a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/ArtistPojo.java b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/ArtistPojo.java new file mode 100644 index 0000000000..b43ce4c8ea --- /dev/null +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/ArtistPojo.java @@ -0,0 +1,44 @@ +/***************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + ****************************************************************/ +package org.apache.cayenne.tutorial.pojo; + +import java.time.LocalDate; + +import org.apache.cayenne.tutorial.persistent.Artist; + +// tag::content[] +public class ArtistPojo { + + private String name; + private LocalDate date; + + public ArtistPojo(Artist artist) { + this.name = artist.getName(); + this.date = artist.getDateOfBirth(); + } + + public String getName() { + return name; + } + + public LocalDate getDate() { + return date; + } +} +// end::content[] diff --git a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/GalleryPojo.java b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/GalleryPojo.java new file mode 100644 index 0000000000..5a3b675908 --- /dev/null +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/GalleryPojo.java @@ -0,0 +1,34 @@ +/***************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + ****************************************************************/ +package org.apache.cayenne.tutorial.pojo; + +import org.apache.cayenne.tutorial.persistent.Gallery; + +public class GalleryPojo { + + private String name; + + public GalleryPojo(Gallery gallery) { + this.name = gallery.getName(); + } + + public String getName() { + return name; + } +} diff --git a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/PaintingPojo.java b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/PaintingPojo.java new file mode 100644 index 0000000000..dce8927694 --- /dev/null +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/pojo/PaintingPojo.java @@ -0,0 +1,34 @@ +/***************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + ****************************************************************/ +package org.apache.cayenne.tutorial.pojo; + +import org.apache.cayenne.tutorial.persistent.Painting; + +public class PaintingPojo { + + private String name; + + public PaintingPojo(Painting painting) { + this.name = painting.getName(); + } + + public String getName() { + return name; + } +} diff --git a/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/resource/CayenneResource.java b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/resource/CayenneResource.java new file mode 100644 index 0000000000..78af611296 --- /dev/null +++ b/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial/resource/CayenneResource.java @@ -0,0 +1,100 @@ +/***************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + ****************************************************************/ +package org.apache.cayenne.tutorial.resource; + +import javax.inject.Inject; +import javax.inject.Singleton; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.util.List; +import java.util.stream.Collectors; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.apache.cayenne.Cayenne; +import org.apache.cayenne.ObjectContext; +import org.apache.cayenne.query.ObjectSelect; +import org.apache.cayenne.tutorial.config.CayenneServerRuntimeFactory; +import org.apache.cayenne.tutorial.persistent.Artist; +import org.apache.cayenne.tutorial.pojo.ArtistPojo; + +// tag::content[] +@Path("/") +@Singleton +public class CayenneResource { + + @Inject + private CayenneServerRuntimeFactory runtimeFactory; + + @GET + @Path("/artists") + @Produces(MediaType.APPLICATION_JSON) + public List artists() { + return ObjectSelect.query(Artist.class) + .select(runtimeFactory.get().newContext()) + .stream() + .map(ArtistPojo::new) + .collect(Collectors.toList()); + } + + @POST + @Path("/artist") + @Produces(MediaType.APPLICATION_JSON) + public Response createArtist(@QueryParam("name") String name, @QueryParam("date") String date) { + ObjectContext context = runtimeFactory.get().newContext(); + Artist artist = context.newObject(Artist.class); + artist.setName(name); + artist.setDateOfBirthString(date); + context.commitChanges(); + return Response.status(201).entity(new ArtistPojo(artist)).build(); + } + + @PUT + @Path("/artist/{id}") + @Produces(MediaType.APPLICATION_JSON) + public Response updateArtist(@PathParam("id") int id, + @QueryParam("name") String newName, + @QueryParam("date") String newDate) throws JsonProcessingException { + ObjectContext context = runtimeFactory.get().newContext(); + Artist artist = Cayenne.objectForPK(context, Artist.class, id); + if(artist != null) { + if (newName != null) { + artist.setName(newName); + } + if (newDate != null) { + artist.setDateOfBirthString(newDate); + } + context.commitChanges(); + return Response.status(200).entity(new ArtistPojo(artist)).build(); + } + + return Response.status(404) + .entity(new ObjectMapper() + .writeValueAsString("Entity for id:" + id + " not found.")) + .build(); + } +} +// end::content[] diff --git a/tutorials/tutorial/src/main/webapp/WEB-INF/web.xml b/tutorials/tutorial/src/main/webapp/WEB-INF/web.xml index eabc19694a..176b9d9915 100644 --- a/tutorials/tutorial/src/main/webapp/WEB-INF/web.xml +++ b/tutorials/tutorial/src/main/webapp/WEB-INF/web.xml @@ -1,41 +1,36 @@ - - - + Cayenne Rest Demo - http://www.apache.org/licenses/LICENSE-2.0 + + Cayenne Rest Demo + org.glassfish.jersey.servlet.ServletContainer + + javax.ws.rs.Application + org.apache.cayenne.tutorial.config.CayenneConfig + + 1 + + + Cayenne Rest Demo + /cayenne/* + - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - - Cayenne Tutorial - - - - cayenne-project - org.apache.cayenne.configuration.web.CayenneFilter - - - cayenne-project - /* - - - index.jsp - \ No newline at end of file diff --git a/tutorials/tutorial/src/main/webapp/detail.jsp b/tutorials/tutorial/src/main/webapp/detail.jsp deleted file mode 100644 index 86e51d6ec7..0000000000 --- a/tutorials/tutorial/src/main/webapp/detail.jsp +++ /dev/null @@ -1,89 +0,0 @@ - -<%@ page language="java" contentType="text/html" %> -<%@ page import="org.apache.cayenne.tutorial.persistent.*" %> -<%@ page import="org.apache.cayenne.*" %> -<%@ page import="java.time.format.DateTimeFormatter"%> - -// tag::content[] -<% - ObjectContext context = BaseContext.getThreadObjectContext(); - String id = request.getParameter("id"); - - // find artist for id - Artist artist = null; - if(id != null && id.trim().length() > 0) { - artist = Cayenne.objectForPK(context, Artist.class, Integer.parseInt(id)); - } - - if("POST".equals(request.getMethod())) { - // if no id is saved in the hidden field, we are dealing with - // create new artist request - if(artist == null) { - artist = context.newObject(Artist.class); - } - - // note that in a real application we would so dome validation ... - // here we just hope the input is correct - artist.setName(request.getParameter("name")); - artist.setDateOfBirthString(request.getParameter("dateOfBirth")); - - context.commitChanges(); - - response.sendRedirect("index.jsp"); - } - - if(artist == null) { - // create transient artist for the form response rendering - artist = new Artist(); - } - - String name = artist.getName() == null ? "" : artist.getName(); - DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyyMMdd"); - String dob = artist.getDateOfBirth() == null - ? "" :artist.getDateOfBirth().format(formatter); -%> - - - Artist Details - - -

Artists Details

-
- " /> - - - - - - - - - - - - - -
Name:
Date of Birth (yyyyMMdd):
-
- - -// end::content[] \ No newline at end of file