e375cf7a67cf05402aeeaea43b80c1572ddf1831
[java-idp.git] / custom / README.txt
1 The custom directory contains the information necessary to build 
2 extension for the Shibboleth IdP and SP at the same time they are built, and
3 have these extensions bundled with their respective war file.
4
5 1. Directory Structure
6     custom
7       /lib - this directory is where an extension and its 
8              libraries are placed after they are built
9       /web - this directory is where an extension's web pages
10              are placed after the extension is built
11       extension-build.properties - this contains default properties 
12                                  needed for the extension build process
13                                  !!! DO NOT EDIT THIS FILE !!!
14       extension-build.xml - the ant build file for building extensions
15                                  !!! DO NOT EDIT THIS FILE !!!
16       README.txt - this document
17                                
18
19 2. Using the Extension Build Process
20 The extension build process depends on an extension having a specific directory
21 structure, so that the extension build file knows where to find everything.  The 
22 root directory of you extension can be named anything you with, but it must contain
23 the following directories
24     your-extension-directory/
25        etc/ - [Optional] This directory contains anything that isn't Java source but still needs 
26               to be on the classpath.  This can include subdirectories, and can be excluded.
27        lib/ - [REQUIRED if 'src' is present] any third party jars your extension needs
28        src/ - [Optional] your extension's source
29        tests/ - [Optional] Your extension's JUnit test case source.
30        web/ - [Optional] Any web pages, images, JSPs, etc. that should be included with the war
31        build.properties - [REQUIRED] build properties for your extension 
32                             (see below for required and optional properties)
33   
34 2.1 Steps for Using the Extensions Build Process
35 I.  Create a directory under the custom directory with the structure mentioned above.  Any 
36 extra directories will be ignored so it is safe to bundle additional information with your 
37 extension such as documentation.
38
39 II. Place your code and other resources in the directory structure you just set up
40
41 III. Compile and deploy Shibboleth as normal.
42
43 2.2 Build File Properties
44   The build file supports the following properties on a per-extension basis.
45     ext.name - [REQUIRED] The name of your resulting extension jar file (.jar will be appended to the name)
46     gen.ext.docs - [Optional] This controls whether Java docs will be generated for your
47                    extension.  A value of "true" will result in them being generated, any other 
48                    value will result in them not being generated, if this property is missing 
49                    the default value of "true" is used.
50     test.ext - [Optional] This controls whether the JUnit tests for your extension are run.
51                    A value of "true" will result in them being run, any other value will result 
52                    in them not being skipped, if this property is missing the default value of 
53                    "true" is used.
54
55 3. Cautionary Note
56 DO NOT include libraries, with your extension, that are included with the Shibboleth
57 IdP or SP.  If you do, and there are version mismatches between the two jars, you will get 
58 unexpected exceptions during runtime as class versions conflict.
59
60 4. Common Errors
61 4.1 /path/to/extension/lib not found
62   This error occurs because Ant is unable to ignore references to directories of jars that don't
63   exist.  Simply create a 'lib' directory in your extension directory structure, you do not have 
64   to place anything in it.
65   
66 4.2 Duplicate web resources
67   If Ant encounters more than one web resource, like a JSP page, with the same name in the same 
68   destination in the war it will place N copies of that file in the war (per the zip spec), one 
69   for each time it encounters the file.  The contents of ALL files will be the contents of the 
70   last file with that name that it encountered.  So, if you attempt to override the login.jsp file
71   in your extension, for example, your war will have two login.jsp files and both will contain the 
72   contents of your extension's log in jsp (because it's encountered after the main shib one).