Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/Examples/JPARS/Simple"
< EclipseLink | Examples
m (→Installation) |
m (→Installation and Configuration) |
||
| (41 intermediate revisions by the same user not shown) | |||
| Line 17: | Line 17: | ||
* REST client ([https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en Chrome Postman REST Client] is used in this example, but you can use your favorite REST Client) | * REST client ([https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en Chrome Postman REST Client] is used in this example, but you can use your favorite REST Client) | ||
| − | === Overview === | + | === Overview === |
| − | The following steps will be performed in setting up and running this example in your own environment | + | The following steps will be performed in setting up and running this example in your own environment |
| − | # Installation & Configuration | + | #Installation & Configuration |
| − | # | + | #*Check out student example from GIT |
| − | # | + | #*Database connectivity |
| − | # | + | #*GlassFish - Datasource configuration |
| − | # | + | #*Verify config |
| − | # | + | #*Deploy web application |
| − | # Running the Example | + | #Running the Example<br> |
| − | # | + | #*View metadata |
| − | + | #*Create entity | |
| − | # | + | #*Update entity |
| − | # | + | #*Query entity |
| − | # | + | #*Delete entity |
| − | # | + | |
<span style="display: none;" id="1362671130064S"> </span> | <span style="display: none;" id="1362671130064S"> </span> | ||
| − | == Installation == | + | == Installation and Configuration == |
| − | + | 1. Clone "examples" from git. The "student" example is stored under [http://git.eclipse.org/c/eclipselink/examples.git/tree/student student] folder. | |
git clone git://git.eclipse.org/gitroot/eclipselink/examples.git | git clone git://git.eclipse.org/gitroot/eclipselink/examples.git | ||
| − | + | 2. 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. <br> <br> [[Image:2013-03-07 12 31 16-.png|Configuring JDBC Connection Pool]] <br> <br> [[Image:JDBC Resource.png|JDBC Resource]] <br> | |
| − | + | <br> | |
| − | == Running the Example == | + | 3. Lauch eclipse. Select File->Import->Maven->Existing Maven Projects, hit next and point Root Directory to student folder. Hit finish. |
| + | |||
| + | <br> | ||
| + | |||
| + | [[Image:2013-03-07 12 57 52-Java EE - Eclipse Platform.png]] | ||
| + | |||
| + | <br> | ||
| + | |||
| + | 4. Build the student project. | ||
| + | |||
| + | 5.Configure a server. Click "new server wizard" link on the Servers tab. | ||
| + | |||
| + | <br> | ||
| + | |||
| + | [[Image:Server.png]] | ||
| + | |||
| + | <br> | ||
| + | |||
| + | 6. Select GlassFish 3.1.2 | ||
| + | |||
| + | <br> | ||
| + | |||
| + | [[Image:Gf.png]] | ||
| + | |||
| + | <br> | ||
| + | |||
| + | 7. Enter domain directory, admin name and password based on your installation and hit Finish. | ||
| + | |||
| + | <br> | ||
| + | |||
| + | [[Image:Example domain.png]] | ||
| + | |||
| + | <br> | ||
| + | |||
| + | 8. Deploy student.web. Right click on the Glassfish (on Servers tab), select "student.web" in available resources list. Hit Add and Finish. | ||
| + | |||
| + | <br> | ||
| + | |||
| + | [[Image:St deploy.png]] | ||
| + | |||
| + | <br> | ||
| + | |||
| + | Now, you are ready to run the student example. | ||
| + | |||
| + | == Running the Example == | ||
| + | |||
| + | *Launch Chrome and Postman | ||
| + | *Get metadata: GET http://localhost:8080/student.web/persistence/v1.0/jpars_example_student/metadata | ||
| + | |||
| + | [[Image:Metadata 2.png]]<br> | ||
| + | |||
| + | <br> | ||
| + | |||
| + | *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): | ||
| + | |||
| + | {<br> "id": 65,<br> "name": "Jane Smith",<br> "courses": [<br> {<br> "id":101,<br> "name": "math"<br> }<br> ]<br> } | ||
| + | |||
| + | <br> | ||
| + | |||
| + | [[Image:Post.png]] | ||
| + | |||
| + | <br> | ||
| + | |||
| + | *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. | ||
| + | |||
| + | [[Image:Query.png]] | ||
| + | |||
| + | <br> | ||
| + | |||
| + | *Delete student: DELETE http://localhost:8080/student.web/persistence/v1.0/jpars_example_student/entity/Student/65 | ||
| + | |||
| + | [[Image:Delete.png]] | ||
Revision as of 11:35, 13 March 2013
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.
Environment
The following are the minimal requirements for this example.
- EclipseLink 2.4.2
- Eclipse Java EE IDE - Juno Release
- Git access to eclipselink examples git repository. The steps to connect to the repo can be found below.
- Glassfish 3.1.2
- REST client (Chrome Postman REST Client is used in this example, but you can use your favorite REST Client)
Overview
The following steps will be performed in setting up and running this example in your own environment
- Installation & Configuration
- 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. Clone "examples" from git. The "student" example is stored under student folder.
git clone git://git.eclipse.org/gitroot/eclipselink/examples.git
2. 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.
3. Lauch eclipse. Select File->Import->Maven->Existing Maven Projects, hit next and point Root Directory to student folder. Hit finish.
4. Build the student project.
5.Configure a server. Click "new server wizard" link on the Servers tab.
6. Select GlassFish 3.1.2
7. Enter domain directory, admin name and password based on your installation and hit Finish.
8. 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
- Get metadata: GET http://localhost:8080/student.web/persistence/v1.0/jpars_example_student/metadata
- 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):
{
"id": 65,
"name": "Jane Smith",
"courses": [
{
"id":101,
"name": "math"
}
]
}
- 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
