Jump to: navigation, search

Difference between revisions of "EclipseLink/Examples/JPARS/Simple"

m
m (Installation and Configuration)
(18 intermediate revisions by the same user not shown)
Line 26: Line 26:
 
#*GlassFish - Datasource configuration  
 
#*GlassFish - Datasource configuration  
 
#*Verify config  
 
#*Verify config  
#*Populate database
 
 
#*Deploy web application  
 
#*Deploy web application  
 
#Running the Example<br>  
 
#Running the Example<br>  
 
#*View metadata  
 
#*View metadata  
#*Query entities
+
#*Create entity
#*Create entity  
+
#*Update entity  
#*Delete entity  
+
#*Query entity  
#*Update entity
+
#*Delete entity
  
 
<span style="display: none;" id="1362671130064S">&nbsp;</span>
 
<span style="display: none;" id="1362671130064S">&nbsp;</span>
Line 39: Line 38:
 
== Installation and Configuration  ==
 
== 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.  
+
1. Clone "examples" from git. The "student" example is stored under [http://git.eclipse.org/c/eclipselink/examples.git/tree/student student]&nbsp;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 a JDBC Connection Pool called "'''jdbc/JPARSStudentDS'''" and define a new&nbsp;JDBC Resources 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>  
+
2. Configure datasource. Create an XA Datasource connection pool called "'''JPARSStudentDS'''" and define a new&nbsp;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>  
 
<br>  
  
3. Run &nbsp;'''createDDL.jdbc''' script under&nbsp;examples\student\student.model, populate database tables required for the student example.
+
3. Lauch eclipse. Select File-&gt;Import-&gt;Maven-&gt;Existing Maven Projects, hit next and point Root Directory to student folder. Hit finish.  
 
+
4. Lauch eclipse. Select File-&gt;Import-&gt;Maven-&gt;Existing Maven Projects, hit next and point Root Directory to student folder. Hit finish.  
+
  
 
<br>  
 
<br>  
Line 57: Line 54:
 
<br>  
 
<br>  
  
5. Build the student project.  
+
4. Build the student project.  
  
6. Configure a server. Click "new server wizard" link on the Servers tab.  
+
5.Configure a server. Click "new server wizard" link on the Servers tab.  
  
 
<br>  
 
<br>  
Line 67: Line 64:
 
<br>  
 
<br>  
  
7. Select GlassFish 3.1.2  
+
6. Select GlassFish 3.1.2  
  
 
<br>  
 
<br>  
Line 75: Line 72:
 
<br>  
 
<br>  
  
8. Enter domain directory, admin name and password based on your installation and hit Finish.  
+
7. Enter domain directory, admin name and password based on your installation and hit Finish.  
  
 
<br>  
 
<br>  
Line 83: Line 80:
 
<br>  
 
<br>  
  
9. Deploy student.web. Right click on the Glassfish (on Servers tab), select "student.web" in available resources list. Hit Add and Finish.  
+
8. Deploy student.web. Right click on the Glassfish (on Servers tab), select "student.web" in available resources list. Hit Add and Finish.  
  
 
<br>  
 
<br>  
Line 93: Line 90:
 
Now, you are ready to run the student example.&nbsp;
 
Now, you are ready to run the student example.&nbsp;
  
== Running the 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/ &nbsp;(with the following body as an example):
 +
 
 +
&nbsp; &nbsp; &nbsp; {<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "id": 65,<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "name": "Jane Smith",<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "courses": [<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;{<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;"id":101,<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;"name": "math"<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;}<br>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ]<br>&nbsp; &nbsp; &nbsp; }
 +
 
 +
<br>
 +
 
 +
[[Image:Post.png]]
 +
 
 +
<br>
 +
 
 +
*Execute a named query: GET&nbsp;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&nbsp;http://localhost:8080/student.web/persistence/v1.0/jpars_example_student/entity/Student/65
 +
 
 +
[[Image:Delete.png]]

Revision as of 10: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.

Overview

The following steps will be performed in setting up and running this example in your own environment

  1. Installation & Configuration
    • Check out student example from GIT
    • Database connectivity
    • GlassFish - Datasource configuration
    • Verify config
    • Deploy web application
  2. 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.

Configuring JDBC Connection Pool

JDBC Resource


3. Lauch eclipse. Select File->Import->Maven->Existing Maven Projects, hit next and point Root Directory to student folder. Hit finish.


2013-03-07 12 57 52-Java EE - Eclipse Platform.png


4. Build the student project.

5.Configure a server. Click "new server wizard" link on the Servers tab.


Server.png


6. Select GlassFish 3.1.2


Gf.png


7. Enter domain directory, admin name and password based on your installation and hit Finish.


Example domain.png


8. Deploy student.web. Right click on the Glassfish (on Servers tab), select "student.web" in available resources list. Hit Add and Finish.


St deploy.png


Now, you are ready to run the student example. 

Running the Example

Metadata 2.png


      {
          "id": 65,
          "name": "Jane Smith",
          "courses": [
               {
                   "id":101,
                   "name": "math"
               }
          ]
      }


Post.png


Query.png


Delete.png