4.6 Downloading and Installing Oracle REST Data Services

Learn about downloading and installing Oracle REST Data Services.

4.6.1 Downloading Oracle REST Data Services

Learn how to download Oracle REST Data Services.

Tip:

By default, the context root for accessing Oracle Application Express through Oracle REST Data Services is /ords. If you wish to have a context root of /apex for accessing Oracle Application Express, rename the ords.war file to apex.war before installing Oracle REST Data Services. See "Installing Oracle REST Data Services" in Oracle REST Data Services Installation, Configuration, and Development Guide.

To download Oracle REST Data Services:

  1. Download the latest release of Oracle REST Data Services from the following site:
    http://www.oracle.com/technetwork/developer-tools/rest-data-services/downloads/index.html
    

    Note that the version.number in the file name reflects the current release number.

  2. Unzip the downloaded zip file into a directory (or folder) of your choice:
    • UNIX and Linux: unzip ords.version.number.zip

    • Windows: Double-click the file ords.version.number.zip in Windows Explorer

  3. Copy the images directory, apex/images, from the Oracle Application Express software ZIP to a location on the file system where Oracle REST Data Services is installed.
  4. See Oracle REST Data Services Installation, Configuration, and Development Guide and follow and complete all installation and configuration steps.
  5. For Oracle Database 12c multitenant architecture, ensure that you configure the connection using the service name of the specific pluggable database (PDB) you want to access. Do not use the service name of the CDB$ROOT unless you are configuring Oracle REST Data Services to address PDBs through the URL. See Oracle REST Data Services Installation, Configuration, and Development Guide for more information.

4.6.2 About Configuring Oracle REST Data Services Behind a Reverse Proxy or Load Balancer

When Oracle Application Express is running behind a reverse proxy or load balancer, it is important to communicate the original HTTP hostname and protocol as seen by the user's browser to the Application Express engine.

The Application Express engine uses this information to generate valid URLs in HTML responses and HTTP redirects that the user's browser can successfully follow. The exact configuration steps depend on your Java EE application server. For example, for Oracle WebLogic Server, this is accomplished using Oracle WebLogic Server Proxy Plug-Ins. To learn more, see your Java EE application server documentation.

4.6.3 Web Server HTTP POST Request Limits

Learn about Web Server HTTP POST request limits.

When running Oracle REST Data Services in standalone mode or within a Tomcat Java Container, size limits are being imposed on POST requests which are not file uploads. Application Express users will encounter these limits when uploading data in SQL Workshop using Copy and Paste or when using Copy and Paste while building an Application from Spreadsheet.

  • When running Oracle REST Data Services in Standalone Mode, the default limit is 200 kilobytes for ORDS 3.0.8 and below and 10MB for ORDS 3.0.9 and above. For 3.0.8 and below it is recommended to increase the limit as follows:

    Set the Java System property  org.eclipse.jetty.server.Request.maxFormContentSize to a higher value in bytes. You can set this property upon startup of Oracle REST Data Services. For example: java -Dorg.eclipse.jetty.server.Request.maxFormContentSize=3000000 -jar ords.war

  • When running on Oracle HTTP Server with mod_plsql, the default is unlimited. No action is required.

  • When running on the Embedded PL/SQL Gateway, the limit is 2 Gigabytes. No action is required.

  • When running on Apache Tomcat, the default limit is 2 megabytes. Adjust Apache Tomcat's maxPostSize parameter to change that limit.

    See Also:

    "http://tomcat.apache.org/" for more information.

4.6.4 Disabling Oracle XML DB Protocol Server

If you were previously using the embedded PL/SQL gateway and now want to use Oracle REST Data Services, you need to disable the Oracle XML DB Protocol Server.

To disable Oracle XML DB Protocol Server:

  1. Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS specifying the SYSDBA role. For example:
    • On Windows:

      SYSTEM_DRIVE:\ sqlplus /nolog
      SQL> CONNECT SYS as SYSDBA
      Enter password: SYS_password
      
    • On UNIX and Linux:

      $ sqlplus /nolog
      SQL> CONNECT SYS as SYSDBA
      Enter password: SYS_password
      
  2. Run the following command:
    EXEC DBMS_XDB.SETHTTPPORT(0);