SOA Gateway

6/30/2015Document Display Oracle E­Business Suite Integrated SOA Gateway 12.1.3 REST Services Update (Doc ID 1998019.1) This document describes the information on enabling Oracle E­Business Suite REST services provided through Oracle E­Business Suite Integrated SOA Gateway Release 12.1.3. The associated documentation accompanied with this update is also attached in this document. The most current version of this document is available in My Oracle Support Knowledge Document 1998019.1. There is a change record at the end of this document. In This Document This document includes the following sections: Section 1: About Oracle E­Business Suite Integrated SOA Gateway Release 12.1.3 REST Services Update Section 1.1 Enabling Oracle E­Business Suite Integrated SOA Gateway REST Services Section 2: Key Features Section 3: Related Documentation Change Record   SECTION 1: ABOUT THE ORACLE E­BUSINESS SUITE INTEGRATED SOA GATEWAY RELEASE 12.1.3 REST SERVICES UPDATE This update introduces REST service capabilities in Oracle E­Business Suite Release 12.1.3. It is back­ported on top of Oracle E­Business Suite Integrated SOA Gateway Release 12.1.3 from Release 12.2. REST services can be used for user­driven applications, such as for mobile, tablet, or handheld devices.   Section 1.1: Enabling Oracle E­Business Suite Integrated SOA Gateway REST Services Note: Ensure that you configure Oracle E­Business Suite Integrated SOA Gateway Release 12.1.3 to enable the REST service features. If Oracle E­Business Suite Integrated SOA Gateway is not configured, follow the setup tasks described in My Oracle Support Knowledge Document 556540.1 to configure Oracle E­Business Suite Integrated SOA Gateway. The REST service patches listed here can be applied in sequence as part of the step 1 in Section 1.2 of the Document 556540.1.  If Oracle E­Business Suite Integrated SOA Gateway is already configured in your instance, then apply these REST service patches in the sequence mentioned in this section to enable the REST service features. To enable and use the REST service features provided through this update, apply the following prerequisite patches in the sequence mentioned below: 1.  Patch 17884289 (Patch R12.AD.B.delta.4) Ensure that you follow the instructions in the patch readme and run adadmin as described in the My Oracle Support Knowledge Document 1640482.1, Oracle E­Business Suite Applications DBA Readme, Release 12.1.3+ (R12.AD.B.Delta.4, Patch 17884289). 2.  Patch 19554072:R12.TXK.B: Request to Add REST Servlet Mapping to OAFM. 3.  Patch 20879049:R12.OWF.B: ISG REST Services Backport to 12.1.3 ­ Datamodel and Parser Changes. https://support.oracle.com/epmos/faces/SearchDocDisplay?_adf.ctrl­state=dcozo7b1m_9#plsql 1/5 Ensure that you apply this patch in hotpatch mode. These supported interface types are: PL/SQL APIs Java Bean Services Application Module Services A user who has the Integration Repository Administrator role can perform the following tasks in the REST Web Service tab to manage the REST service life cycle activities: https://support.FND. 5.6/30/2015 Document Display 4.oracle.3 now allows supported interface types to become WADL­based REST services.1.B: Backport ­ Register AOL Security Services in Integration Repository.com/epmos/faces/SearchDocDisplay?_adf.  Patch 20677714:R12.ctrl­state=dcozo7b1m_9#plsql 2/5 . with all services running.3 ­ Consolidated Patch for Server and UI   SECTION 2: KEY FEATURES The key features provided through this update include: Support for REST Services Support for PL/SQL APIs as REST Services Support for Java Bean Services as REST Services Support for Application Module Services Security Services   Support for REST Services In addition to supporting WSDL­based SOAP service generation and deployment.OWF.1.B: ISG REST Services Backport to 12. Oracle E­Business Suite Integrated SOA Gateway Release 12.  Patch 20879097:R12. com/epmos/faces/SearchDocDisplay?_adf. This action not only undeploys the REST service. Support for Java Bean Services as REST Services Java APIs whose methods use parameters of either simple data types or serializable Java Beans are categorized as Java Bean Services. Please note that PL/SQL APIs is the only interface type that can be exposed as both SOAP and REST services; Java Bean Services and Application Module Services can be exposed as REST services only. Support for PL/SQL APIs as REST Services Oracle E­Business Suite Integrated SOA Gateway now supports REST service enablement through the Integration Repository for PL/SQL APIs. https://support. but also resets the service to its initial state ­ 'Not Deployed'.oracle. Such Java APIs can now be exposed as REST­based web services. Please note that REST services are supported with the synchronous interaction pattern only. PL/SQL APIs can be deployed as REST service operations with POST HTTP method only. a subtype of Java interface. This deploys a REST service to an Oracle E­Business Suite application server.ctrl­state=dcozo7b1m_9#plsql 3/5 . Undeploy a Service The administrator can undeploy a deployed REST service.6/30/2015 Document Display Deploy a Service A supported interface can be exposed as a REST service through a 'Deploy' action. com/epmos/faces/SearchDocDisplay?_adf. Oracle E­Business Suite Integrated SOA Gateway Developer's Guide attached in Section 3: Related Documentation. 2015 Initial publication. predeployed REST services from Oracle Application Object Library. They are mainly used for mobile applications. E12064_08 Oracle E­Business Suite Integrated SOA Gateway Implementation Guide. Similar to Java Bean Services.oracle. For annotation information for Java Bean Services. Unlike other interface types. Such Java classes can be categorized and displayed as a subtype of Java interfaces in the Integration Repository. E12169_08 Oracle E­Business Suite Integrated SOA Gateway Developer's Guide.ctrl­state=dcozo7b1m_9#plsql 4/5 . Oracle E­Business Suite Integrated SOA Gateway Developer's Guide attached in Section 3: Related Documentation. Part No. The Application Module Implementation class is a Java class that provides access to business logic governing the OA Framework­based components and pages. security services are pregranted to all users. Application Module Services can be deployed as REST service operations with POST and GET HTTP methods. initialize application sessions with context information. At run time. Part No. Part No.1. security services help authenticate user credentials. Support for Application Module Services as REST Services Oracle E­Business Suite Integrated SOA Gateway now supports OA Framework Application Modules as REST Services. and authorize access privileges for authenticated users.6/30/2015 Document Display Java Bean Services can be deployed as REST service operations with POST and GET HTTP methods. Integration Repository annotation is also enhanced to support Java APIs as serviceable interfaces. Security Services Security services are a subtype of Java interfaces that is displayed through the Integration Repository. There is no user action needed at design time. Integration Repository annotation is also enhanced to support Application Modules as serviceable interfaces.   SECTION 3: RELATED DOCUMENTATION The Oracle E­Business Suite Integrated SOA Gateway 12. see Appendix A Integration Repository Annotation Standards.   Documentation Notices https://support. For annotation information for Application Module Services.1. They are predefined. E12065_08     Change Record Date Description April 15. see Appendix A Integration Repository Annotation Standards.3 REST Services Update documentation is attached together with this My Oracle Support Knowledge Document 1998019. You can download the PDF files from the following links: Oracle E­Business Suite Integrated SOA Gateway User's Guide.  AMD. please report them to us in writing. For information. This software or hardware is developed for general use in a variety of information management applications. All rights reserved. in any form.ctrl­state=dcozo7b1m_9#plsql 5/5 . disclosure. Access to Oracle Support Oracle customers have access to electronic support through My Oracle Support. integrated software. and other measures to ensure its safe use. Oracle and Java are registered trademarks of Oracle and/or its affiliates. visit the Oracle Accessibility Program website at http://www. and adaptation of the programs. and services from third parties. costs. and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. Other names may be trademarks of their respective owners.oracle. the AMD logo. copy. transmit. Reverse engineering. duplication. broadcast. Oracle and/or its affiliates. or by any means. and/or documentation.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle. translate. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. The information contained herein is subject to change without notice and is not warranted to be error­free.S. publish. If you find any errors. you may not use. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. including any operating system. including applications that may create a risk of personal injury.S.oracle. Didn't find what you are looking for? https://support.com/pls/topic/lookup? ctx=acc&id=trs if you are hearing impaired. and services. disassembly. is prohibited. or services. including any operating system.6/30/2015 Document Display Copyright © 2015. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws.S. then you shall be responsible to take all appropriate fail­safe. visit http://www. exhibit. or damages incurred due to your access to or use of third­party content. modify. For information about Oracle's commitment to accessibility. backup. products. No other rights are granted to the U. perform. or decompilation of this software. delivered to U. products. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International. modification. reproduce. and/or documentation. the following notice is applicable: U. Except as expressly permitted in your license agreement or allowed by law. Inc. unless required by law for interoperability. redundancy. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency­specific supplemental regulations. Government. any programs installed on the hardware. shall be subject to license terms and license restrictions applicable to the programs. As such.S. Opteron. Government. If you use this software or hardware in dangerous applications. license. or display any part. any programs installed on the hardware.com/pls/topic/lookup?ctx=acc&id=docacc. products. integrated software. It is not developed or intended for use in any inherently dangerous applications. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third­party content. UNIX is a registered trademark of The Open Group. GOVERNMENT END USERS: Oracle programs. This software or hardware and documentation may provide access to or information on content.oracle. If this is software or related documentation that is delivered to the U. distribute. Government or anyone licensing it on behalf of the U.S. Oracle Corporation and its affiliates will not be responsible for any loss. use.com/epmos/faces/SearchDocDisplay?_adf.