Simple Example - student
The "student" example is intended to provide a simple example of using JPA-RS with a single entity persistence unit in a web application.
The following are the minimal requirements for this example.
- EclipseLink 2.4.2
- Eclipse Java EE IDE - Juno Release, make sure m2e (the maven integration for Eclipse) is installed.
- Git access to eclipselink examples git repository. The steps to connect to the repo can be found below.
- Glassfish 3.1.2 or later
- REST client (Chrome Postman REST Client is used in this example, but you can use your favorite REST Client)
The following steps will be performed in setting up and running this example in your own environment
- Installation & Configuration
- Install Glassfish 126.96.36.199 or later
- Check out student example from GIT
- Database connectivity
- GlassFish - Datasource configuration
- Verify config
- Deploy web application
- Running the Example
- View metadata
- Create entity
- Update entity
- Query entity
- Delete entity
Installation and Configuration
1. If you are using Glassfish earlier than Glassfish 4.0 (http://dlc.sun.com.edgesuite.net/glassfish/4.0/promoted/) you will need to download newer version of EclipseLink 2.4.2 binaries from http://www.eclipse.org/eclipselink/downloads/nightly.php (2.4.2 Nightly Build Results) and replace following files under $GLASSFISH_HOME/glassfish/modules with corresponding jars you downloaded above:
Make sure you clear Glassfish osgi cache by removing the $GLASSFISH_HOME\glassfish\domains\<your_domain>\osgi-cache directory after you replaced the bundles listed above, and before you restart the Glassfish.
Note: If you want to see JPA-RS logs, add a logger for "org.eclipse.persistence.jpars". Currently exceptions are logged at "FINER" log level, so configure the logger to FINER or FINEST. Use Glassfish Admin Console-> Configurations-> default-config-> Logger Settings-> Log Levels tab -> Add Logger to add a logger for the JPA-RS.
2. Clone "examples" from git. The "student" example is stored under student folder.
3. Configure datasource. Create an XA Datasource connection pool called "JPARSStudentDS" and define a new JDBC Resource using this connection pool. You can use any of the databases supported by the eclipselink.
Your database driver should be place under $GLASSFISH_HOME/glassfish/domains/<your_domain_folder>/lib/ext.
Use "Additional Properties" (shown below) tab to define database URL, User and Password (and other mandatory properties that the database you use might require).
4. Lauch eclipse. Select File->Import->Maven->Existing Maven Projects, hit next and point Root Directory to student folder. Hit finish.
5. Build the student project.
6.Configure a server.
7. Select GlassFish 3.1.2. Click "new server wizard" link on the Servers tab. If you don't see GlassFish listed in available server types, click "Download additional server adapters" and select Oracle Glassfish Server Tools to install GlassFish server adapter.
8. Enter domain directory, admin name and password based on your installation and hit Finish.
9. Deploy student.web. Right click on the Glassfish (on Servers tab), select "student.web" in available resources list. Hit Add and Finish.
Now, you are ready to run the student example.
Running the Example
- Launch Chrome and Postman. Please see Creating and sending requests using Postman if you are not familiar with creating and sending REST request using Postman. If you are using another tool to construct REST requests, please make sure you set Accept header correctly. The Accept header is used by HTTP clients to tell the server what content types they'll accept. The server will then send back a response, which will include a Content-Type header telling the client what the content type of the returned content actually is. HTTP requests can also contain Content-Type headers. With POST or PUT requests, the client actually sends a bunch of data to the server as part of the request, and the Content-Type header tells the server what the data actually is (and thus determines how the server will parse it).The JPA-RS accepts "application/json" and "application/xml" and this example focuses on json.
- Create a student with a course: POST http://localhost:8080/student.web/persistence/v1.0/jpars_example_student/entity/Student/ (with the following body as an example):
"name": "Jane Smith",
- Execute a named query: GET http://localhost:8080/student.web/persistence/v1.0/jpars_example_student/query/Student.findAll to execute named query findAll query as defined in the eclipselink.example.jpars.student.model.Student entity.
- Delete student: DELETE http://localhost:8080/student.web/persistence/v1.0/jpars_example_student/entity/Student/65