Installing the deprecated API (in-process) Server Role for a Java/JSP web application

Only install the deprecated API (in-process) Server Role if you have a pressing reason to do so (for example, because you have legacy code that you are unwilling to migrate). Otherwise, install the API (RESTful) Server Role.

About this task

Installing the deprecated API (in-process) Server Role involves registering Java Custom Tags, configuring Profiling & Personalization, and setting up the Ambient Data Framework. The API (in-process) Server Role is typically installed on the staging or live web site, and takes care of resolving dynamic links between content items.

Procedure

  1. Ensure that all the prerequisites for a Content Delivery Server Role are met on your target system.
  2. Create the following web application directory structure:
    1. In the root folder, create a WEB-INF/ directory.
    2. In the WEB-INF/ directory, create subdirectories classes/ and lib/.
  3. Access the SDL Tridion Sites installation media.
  4. Navigate to the Content Delivery\roles\ folder.
  5. On the installation media, navigate to the Content Delivery\roles\api\in-process\java\lib\ folder.
  6. Copy all the JAR files from this folder to the WEB-INF/lib/ folder of your web application.
  7. Copy the contents of the Content Delivery\roles\api\in-process\config\ folder on the installation media to the WEB-INF/classes/ folder of your web application.
  8. Copy cd_licenses.xml, your Content Delivery license file available from SDL Customer Support, to the WEB-INF/classes directory of your web application.
    If you want to name the file differently or put it in a different location, you need to update the License element in your configuration files.
  9. Optional: Configure logging.
  10. Configure the Storage Layer and optionally encrypt sensitive strings.
  11. If your web application server is JBoss, do the following:
    1. Locate the following files in the WEB-INF/lib/ subdirectory and remove them:
      • stax-api.jar
      • serializer.jar
      • xalan.jar
    2. Access the SDL Tridion Sites installation media, navigate to Content Delivery\resources\web\ and from that location, copy the file jboss-deployment-structure.xml to the WEB-INF/ directory.
    3. Open WEB-INF/web.xml, add the following section and save the file:
      <context-param>
      	<param-name>resteasy.scan</param-name>
      	<param-value>false</param-value>
      </context-param>
      <context-param>
      	<param-name>resteasy.scan.resources</param-name>
      	<param-value>false</param-value>
      </context-param>
      <context-param>
      	<param-name>resteasy.scan.providers</param-name>
      	<param-value>false</param-value>
      </context-param>
  12. If your web application server is WebLogic, do the following:
    1. In the file web.xml in your WEB-INF/ subdirectory, in the web-app element, add the attribute-value pair metadata-complete="true".
    2. Remove the file stax-api.jar from your WEB-INF/lib/ subdirectory.
    3. Access the SDL Tridion Sites installation media, navigate to Content Delivery\resources\web\ and from that location, copy the file weblogic.xml to the WEB-INF/ directory.
  13. Restart the web application.