Slew of documentation and minor functionality changes addresing those listed here
[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        bin/ - [Optional] This directory contains any binary or script files that need to 
26                be installed on the filesystem in the IdP or SP home bin directory.  This 
27                can include subdirectories.  The string's $IDP_HOME$ and $SP_HOME$ will be 
28                exapanded to the system path that the IdP or SP is installed (depending on 
29                which you're installing).
30        etc/ - [Optional] This directory contains any configuration files that need to 
31                be installed on the filesystem under the IdP or SP home etc directory.  This 
32                            can include subdirectories.  All files will be installed into a subdirectory 
33                            named after the extension module.  The strings $IDP_HOME$, $SP_HOME$, and 
34                            $EXTENSION_NAME$ will be exapanded for all files in this directory.
35        lib/ - [REQUIRED if 'src' is present] any third party jars your extension needs
36        src/ - [Optional] your extension's source
37        src-conf/ - [Optional] This directory contains any files which are not java source
38                files but still need to be included in the extension jar (and hence be 
39                available on the classpath).  This can include subdirectories.  The strings 
40                $IDP_HOME$, $SP_HOME$, and $EXTENSION_NAME$ will be exapanded for all files 
41                in this directory.
42        tests/ - [Optional] Your extension's JUnit test case source.
43        web/ - [Optional] Any web pages, images, JSPs, etc. that should be included with the war
44        build.properties - [REQUIRED] build properties for your extension 
45                             (see below for required and optional properties)
46
47 The following directories are created, and destroyed, by the extension build process and as
48 such developers should never rely on them: build, dist, doc/api.  Any other directory may be
49 created and bundled with the extension, the build process will simply ignore them.
50   
51 2.1 Steps for Using the Extensions Build Process
52 I.  Create a directory under the custom directory with the structure mentioned above.  Any 
53 extra directories will be ignored so it is safe to bundle additional information with your 
54 extension such as documentation.
55
56 II. Place your code and other resources in the directory structure you just set up
57
58 III. Compile and deploy Shibboleth as normal.
59
60 2.2 Build File Properties
61   The build file supports the following properties on a per-extension basis.
62     ext.name - [REQUIRED] The name of your resulting extension jar file (.jar will be appended to the name)
63     gen.ext.docs - [Optional] This controls whether Java docs will be generated for your
64                    extension.  A value of "true" will result in them being generated, any other 
65                    value will result in them not being generated, if this property is missing 
66                    the default value of "true" is used.
67     test.ext - [Optional] This controls whether the JUnit tests for your extension are run.
68                    A value of "true" will result in them being run, any other value will result 
69                    in them not being skipped, if this property is missing the default value of 
70                    "true" is used.
71
72 3. Cautionary Note
73 DO NOT include libraries, with your extension, that are included with the Shibboleth
74 IdP or SP.  If you do, and there are version mismatches between the two jars, you will get 
75 unexpected exceptions during runtime as class versions conflict.
76
77 4. Common Errors
78 4.1 /path/to/extension/lib not found
79   This error occurs because Ant is unable to ignore references to directories of jars that don't
80   exist.  Simply create a 'lib' directory in your extension directory structure, you do not have 
81   to place anything in it.
82   
83 4.2 Duplicate web resources
84   If Ant encounters more than one web resource, like a JSP page, with the same name in the same 
85   destination in the war it will place N copies of that file in the war (per the zip spec), one 
86   for each time it encounters the file.  The contents of ALL files will be the contents of the 
87   last file with that name that it encountered.  So, if you attempt to override the login.jsp file
88   in your extension, for example, your war will have two login.jsp files and both will contain the 
89   contents of your extension's log in jsp (because it's encountered after the main shib one).
90