Creating a Jax-Rs Application with ADF Model using Jdeveloper

While working on Oracle PaaS it is a common requirement to build REST services and our first choice is usually ADF.

 ADF is good for handling simple Requests and Response pattern and uses ADF model and transaction management to handle and fulfill requests. But there are times when we need to have a complex structure and a framework which can provide a stable and secure Model and also handle complex Request and Response structure.

This is where we can use combination of Jax-Rs with ADF Model approach, Jax-Rs can handle any type of complex Request and Response type and ADF Model can handle DB transactions and security.

Below are the steps for creating the same:

  • Create ADF Rest Web Application
    • Name : XxcomSampleJaxRsRestServiceApp
    • Pkg : xxcom.test.jaxrs
    • Model: XxcomSampleJaxRsRestServiceModel





  • Assign Database to Model project so DB components can be created
  • Create AM
    • Name : XxcomSampleJaxRsRestServiceAM
    • Pkg: xxcom.test.jaxrs.model.am

    • Keep Default settings and Finish
  • Set Connection pooling to true in AM
    • Modify Data Source
    • Add <AM-Pooling jbo.doconnectionpooling="true"/>

  • Delete the Auto generated RestProject
  • Add New Custom REST Web Service Project
    • New Project > Rest WebService Project
    • Name : XxcomSampleJaxRsWebService
    • Pkg : xxcom.test.jaxrs.rest
  • Create New Rest Service
    • Create New > Restful Service in WebService Project


    • Application Class : xxcom.test.jaxrs.rest.RestApplication
    • Appliction Path : api
    • Resource: SampleRestService
    • Service class is created which can then be modified to meet business needs

  • Add New Custom Java Project for storing custom types and their corresponding pojo’s
    • Name : XxcomSampleJaxRsService
    • Pkg : xxcom.test.jaxrs.service
  • Create a Request and Response structure class
    • Create Request Class
      • Name : SampleRestServiceRequest
      • Pkg : xxcom.test.api.model

    • Define Request Parameters inside Request Class
      • Below image shows the structure created using pojo class
    • Create Response Class
      • Name : SampleRestServiceResponse
      • Pkg : xxcom.test.api.model
    • Define response parameters inside Response class

  • Add Dependency XxcomSampleJaxRsService to XxcomSampleJaxRsWebService
  • Edit SampleRestService to include custom Request and Response structure
Currently the response is sum of 2 input params
  • Uncheck AutoGenerate and Sync Weblogic JDBC Descriptors
    • Navigate to Application Properties > Deployment > Weblogic > Uncheck Auto Generate and Sync Weblogic JDBCDescriptors During Deployment
  • Modify WebAppName and Context Root
    • Navigate to XxcomSampleJaxRsWebService> Properties > Java EE Application
  • Compile and run the service, you can test the same using Postman





This is a basic application used to understand the components needed for developing Jax-Rs Application, in future blogs we will be doing a more practical example using ADF Model, modifying Custom Url, removing null properties from Response.

Comments

Post a Comment

Popular posts from this blog

Mavenize an Oracle ADF Application

Image
To Mavenize an Oracle ADF Application first step would be to Setup Maven in Jdeveloper after this we Mavenize Oracle ADF Application . Follow below steps to Setup Maven in Jdeveloper 1.> Navigate to Tools > Preferences > Maven > Settings 2.> Get user settings file path - For me it is : C:\Users\username\.m2\settings.xml 3.> Navigate to path and modify settings file server tag as below  <servers>     <server>     <id>maven.oracle.com</id>     <username>OracleUserName</username>     <password>OraclePwd</password>     <configuration>       <basicAuthScope>         <host>ANY</host>         <port>ANY</port>         <realm>OAM 11g</realm>       </basicAuthScope>       <httpConfiguration>       ...
Read more

Creating Column Filter on a VBCS Table using ListDataProvider(LDP)

Image
 In this blog we will create filter functionality for a table using ListDataProvider (LDP). Create an ADP based Table in VBCS based on any Data Source For this example, I will use a JSON file as Data Source and create an ADP based table for the same Create textboxes on top of columns which will act as filters for the columns Create 5 textboxes on top of each column to act as filters Create searchObject variable and map all filter text values to it Convert the ADP to ListDataProviderView Create function to convert ADP to ListDataProviderView Call custom function getListViewProvider , it takes a custom ADP and filter Criteria as parameters, on Page all data are shown hence filter criteria passed will be null Call on vb-Enter event and assign the same to oj-table data Assign a single value change event for all the filter fields Call custom function getFilterCriterion to get filter criteria for ListDataProviderView Filter the ListDataProviderView based on the filter criteria Run the Ui...
Read more

Using Custom Colors in Sunburst Chart

Image
 In  Previous blogs we have created Sunburst Chart, now we will try to add custom color to the same Create VBCS App with Sunburst Chart Create a Global array and provide it custom rgb color palette values. Now create a custom function which will return an array value randomly or based on any custom logic, for this example i will be passing the color based on the node’s id value. Replace the old function with the newly created one Now you can see custom colors as per our logic and also these colors will remain static and will not change every time the ui is opened.
Read more