Documentation Center

Installing the API Server Role for a Java Web application

The API 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 installation media.
  4. Navigate to Content Delivery\resources\web\ and copy the file web.xml to the WEB-INF/ directory.
  5. Navigate to Content Delivery\roles\api\java\.
  6. Copy all the JAR files from the lib\ subfolder, and all the JAR files from the third-party-lib\ subfolder, to the WEB-INF/lib/ folder of your Web application.
  7. If you store published content in a database, download the JDBC driver (JAR file) required for your specific database vendor and copy it into the WEB-INF/lib directory of your Web application:
    VendorJDBC DriverRequired JAR
    Microsoft SQL ServerMicrosoft SQL Server JDBC Driver 4.0

    sqljdbc42.jar for Java 8

    sqljdbc4.jar for Java 6 or Java 7

    OracleOracle JDBC driver 11.2.0.3 (deprecated)

    ojdbc6.jar for Java 6 or Java 7

    OracleOracle JDBC driver 12.1.0.1

    ojdbc7-12.1.0.1.jar for Java 8

    ojdbc7.jar for Java 7

    ojdbc6.jar for Java 6

    IBM DB2IBM Data Server Driver for JDBC and SQLJ (9.7 GA) (deprecated)

    Not supported with Java 8

    db2jcc.jar for Java 6 or Java 7

    You can download JDBC drivers from the following locations:
  8. Navigate to \Content Delivery\resources\configurations\.
  9. Copy logback.xml from that folder to the WEB-INF/classes/ subdirectory of your Web application.
  10. Copy and rename the following configuration files to the WEB-INF/classes/ folder of your Web application:
    Corresponding configuration fileRenamed configuration file
    cd_dynamic_conf_sample.xmlcd_dynamic_conf.xml
    cd_storage_conf_sample.xmlcd_storage_conf.xml
    cd_link_conf_sample.xmlcd_link_conf.xml
    cd_wai_conf_sample.xmlcd_wai_conf.xml
  11. Copy cd_licenses.xml, your Content Delivery license file available from SDL Tridion 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.
  12. Optional: Configure logging.
  13. Configure the Storage Layer and optionally encrypt sensitive strings.
  14. 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. If you use JBoss 5.1 or 5.2, add the following JVM property-value pair to the JAVA_OPTS variable: -Dorg.jboss.logging.provider=slf4j
    3. If you use JBoss 6.0 or 6.1, create a file with the following contents called jboss-deployment-structure.xml and save the file in the WEB-INF/ directory:
      <jboss-deployment-structure>
      	<deployment>
      		<exclusions>
      			<module name="org.slf4j" />
      			<module name="org.slf4j.impl" />
      			<module name="com.sun.jersey" />
      			<module name="com.sun.jersey.json" />
      			<module name="com.sun.jersey.core" />   
      		</exclusions>
      	</deployment>
      </jboss-deployment-structure>
    4. If you use JBoss 6.0 or 6.1, 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>
  15. If your Web application server is WebLogic, do the following:
    1. Remove the file stax-api.jar from your WEB-INF/lib/ subdirectory.
    2. Add a weblogic.xml file to the WEB-INF folder of your Web application that forces WebLogic to use the libraries contained in the Web application, rather than its own libraries. The contents of this weblogic.xml file must be as follows:
      <weblogic-web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      	xsi:schemaLocation="http://www.bea.com/ns/weblogic/weblogic-web-app http://www.bea.com/ns/weblogic/weblogic-web-app/1.0/weblogic-web-app.xsd"
      	xmlns="http://www.bea.com/ns/weblogic/weblogic-web-app">
      	<container-descriptor>
      		<prefer-application-packages>
      			<package-name>javax.persistence.**</package-name>
      			<package-name>antlr.*</package-name>
      			<package-name>org.slf4j.**</package-name>
      			<package-name>org.apache.log4j.**</package-name>
      			<package-name>org.apache.xml.serializer.**</package-name>
      		</prefer-application-packages>
      	</container-descriptor>
      </weblogic-web-app>
  16. Access the root of your Web application and copy the file cd_tags.tld (the tag library) from the Content Delivery\resources\tld\ folder on the SDL Tridion installation media to the WEB-INF/lib/ subdirectory of your Web application.
  17. Add the following XML fragment to the web.xml file of the Web application:
    <jsp-config>
    	<taglib>
    		<taglib-uri>cd_tags</taglib-uri>
    		<taglib-location>/WEB-INF/lib/cd_tags.tld</taglib-location>
    	</taglib>
    </jsp-config>
  18. Save and close web.xml.
  19. Restart the Web application.