===============================================================================
Welcome to Apache Jackrabbit  - SPI
===============================================================================

License (see also LICENSE.txt)
===============================================================================

Collective work: Copyright 2006 The Apache Software Foundation.

Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.



Introduction
===============================================================================

This contribution within the Jackrabbit project contains example 
implementations for Jackrabbit SPI:

- spi2dav : SPI implementation on top of WebDAV connecting to a Jackrabbit Jcr-Server.
- spi-rmi : rmi layer
- spi-logger : logging facility

By default the test cases present in the 'client' project are
executed on a setup using:

jcr2spi - spi-rmi - spi2jcr - jackrabbit-core (JCR2SPI2JCROverRMIRepositoryStub)


In order to test the WebDAV remoting with the setup

jcr2spi - spi2dav - jcr-server - jackrabbit-core (JCR2SPIRepositoryStub)

please follow the instruction:

1) setup a jcr-server installation

2) make sure the JCRWebdavServer servlet configuration specifies the 
   'missing-auth-mapping' parameter to contain an empty value:

    <init-param>
      <param-name>missing-auth-mapping</param-name>
      <param-value></param-value>
    <init-param>

3) change 'repositoryStubImpl.properties':
   
   # choose the correct repository stub:
   javax.jcr.tck.repository_stub_impl=org.apache.jackrabbit.jcr2spi.JCR2SPIRepositoryStub
   
   # adjust config for JCR2SPIRepositoryStub (SPI2DAV)
   org.apache.jackrabbit.jcr2spi.repository.url=http://<host>:<port>/jackrabbit/server/


Requirements
===============================================================================

This project assumes that you have already successfully compiled and 
installed the Jackrabbit project into your maven repository. If this is not 
the case,  go back to your jackrabbit directory and build it.

> cd ../../
> mvn install

-> installs all required jar files.

> cd ../contrib/spi
> mvn install