Child pages
  • Installing and Configuring the Variations Web Services - 6.*

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Warning

This page is a work in progress.  Please use Installing and Configuring the Variations Web Services - 6.0 instead.

Variations Web Services

Info

The Variations Web Services are required to run the Variations Web UI and/or the Variations Access Manager.

Perform the following steps as the tomcat user.

...

The instructions below assume you are logged in as root.

Download the Variations Web Services war file.
To download the file,

...

First copy the war to tomcat's webapp directory:

Code Block

cp variations-ws-server.war /usr/localshare/tomcattomcat6/webapps/

Then copy needed files outside of the webapp directory:

Code Block

mkdir /usr/localshare/tomcattomcat6/conf/variations-ws-server/
cp /usr/localshare/tomcattomcat6/webapps/variations-ws-server/WEB-INF/conf/config.xml /usr/localshare/tomcattomcat6/conf/variations-ws-server/
cp /usr/localshare/tomcattomcat6/webapps/variations-ws-server/WEB-INF/conf/accessPolicy-ws.xml /usr/localshare/tomcattomcat6/conf/variations-ws-server/

...

For each web service, a manager connects to a Variations server as a super-user to read and update data. Configure each manager with the appropriate url to your Variations server and the superuser authentication username (protocol and principal) and password:

Code Block

<repository>
        <type>variations</type>
        <url>//example.example.edu:1099/EXAMPLE</url>
        <username>superuser@example.edu</username>
        <password>password</password>
</repository>

For the Metadata web service, you also need to supply the prefix to your OPAC (this is the same as the dml.client.url.catalog system property in your /home/dmlserv/conf/server/dmlserver.xml) as well as replace the hostname in the bibinfo url:

Code Block

<opacurl>http://purl.dlib.indiana.edu/iudl/iucat/</opacurl>
<bibinfourl>http://example.example.edu/variations-ws-server/bibinfo</bibinfourl>

An authentication web service operates to allow restricted access to non-public recordings through the web player and for authentication to the access manager. Configure this authentication proxy by setting the appropriate url to your Variations server along with the realm used by the Variations server:

Code Block

<authenticationproxy>
        <type>variations</type>
        <url>//example.example.edu:1099/EXAMPLE</url>
        <realm>iu.edu</realm>
</authenticationproxy>

...

This configuration file manages the access policy for the Web Services and only needs to be modified if you want to implement IP-based access.

WEB-INF/web.xml

If tomcat is not installed at /usr/local/tomcat/ or you prefer to keep config.xml outside of the variations-ws-server webapp directory at a different location, then edit configPath in WEB-INF/web.xml:

Code Block

<context-param>
       	<param-name>configPath</param-name>
       	<param-value>/usr/local/tomcat/value>${catalina.home}/conf/variations-ws-server/config.xml</param-value>
</context-param>

...

If you prefer to keep the log files outside of tomcat's log directory, then edit the following line in WEB-INF/classes/log4j.properties:

Code Block

log4j.appender.A1.File=${catalina.home}/logs/variations-ws-server.log

...

Once all configuration has been done, then restart tomcat:

...

sudo /etc/init.d/tomcat6 restart

Check that the webapp has loaded properly by browsing to http://webserver.example.edu/variations-ws-server/metadata/145587where webserver.example.edu is replaced by the fully-qualified domain name of your Variations web server.

Note that the first time you try this URL, you may have to accept a security certificate and enter the user name and password you specified with the wsconsumer role in ~tomcat/etc/conftomcat6/tomcat-users.xml. The URL should return an xml document with metadata for a recording (you may have to view the page source to see the full document depending on how your browser displays xml).