SDSS WAYF patch for multi-federation support
[java-idp.git] / src / conf / wayfconfig.xml
1 <?xml version="1.0"?>
2 <WayfConfig 
3         xmlns="urn:mace:shibboleth:wayf:config:1.0" 
4         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
5
6 <!-- The default behaviour of Service is controlled via the elements
7      and attributes below.  Non default behaviour is achieved by
8      specifying any or all of these in the specific
9      DiscoveryServiceHanlder element.
10
11      The handleCookie attribute is one of 'NeverFollow', 'AlwaysFollow',
12      'FollowSingle' or 'ClearCookie' and controls how the WAYF deals
13      with the _saml_idp cookie.
14
15      The cacheDomain attribute sets the domain that the cookie will be
16      written to.
17
18      The cacheExpiration attribute sets the expiration time of the
19      cookie (if the 'Remember for a week' selection is made).
20
21      The jspFile & errorJspFile attributes control the display
22
23      The provideList attribute controls whether a single list of all
24      possible IdPs is presented.  The default wayfs.jsp works best
25      if this is true if provideListofList is true.
26      
27      The provideListOfList attribute controls whether mutiple lists
28      are presented (one for each MetadatProvider).
29
30      The showUsableIdPs attribute controls the contents of the above
31      lists.  The single list (provideList=true) is trimmed by
32      excluding IdPs which do not share a metadata file with the SP.
33      The multiple lists (provideListOfList=true) is trimmed by
34      excluding all lists which do not specify the SP.
35      
36      The SearchIgnore element contains a list of words to be ignored while
37      performing a search.
38 -->
39
40         <Default 
41             handleCookie="NeverFollow"
42             jspFile="/wayf.jsp"
43             errorJspFile="/wayferror.jsp"
44             provideList="false"
45             provideListOfList="true"
46             showUnusableIdPs="false"
47             cacheExpiration="604800" >
48             <SearchIgnore>
49                 <IgnoreText>Institution</IgnoreText>
50                 <IgnoreText>University</IgnoreText>
51                 <IgnoreText>State </IgnoreText>
52                 <IgnoreText>School</IgnoreText>
53             </SearchIgnore>
54         </Default>
55         
56 <!-- The MetadataProvider is in a similar syntax to that used to
57      configure an IdP.  This means that plugins for the IdP can be
58      used interchangably between the IdP and WAYF.
59
60      The identifier element is used to uniquely distinguish the
61      metadata in a Federation element below -->
62
63         <MetadataProvider 
64                 displayName="Put in User Friendly Name here"
65                 identifier="FirstSite"
66                 type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadata"
67                 uri="file:///usr/local/sites.xml"/>
68
69 <!-- If the WAYF is to handle data from more than one metadata source
70      then more metadataproviders can be provided, as below
71         
72        <MetadataProvider 
73                 displayName="Another Name Here"
74                 identifier="SecondSite"
75                 type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadata"
76                 uri="file:/usr/local/moresites.xml"/>
77 -->
78
79 <!-- Every handler has to be declared with a DiscoverServiceHandler
80      element.  As well as the attributes and elements described above,
81      each DiscoveryServiceHandler *MUST* have a location attribute.
82      
83      The default wayf.xml specifies that "/WAYF" and "/*.wayf" are the
84      possibilities for DiscoveryServices.  If a URL matches the above,
85      but does not match any location in a DiscoveryServiceHandler,
86      then the first handler for which the default attribute is set
87      true is invoked -->
88
89
90     <DiscoveryServiceHandler
91         location=".+/WAYF" 
92         default="true" />
93
94 <!-- The ClearCache handler causes the cookie to be deleted.  The jsp shipped
95      with the WAYF refers to this handler -->
96         
97     <DiscoveryServiceHandler
98         location=".+/ClearCache.wayf"
99         handleCookie="ClearCookie" />
100
101 <!-- Example of how to constrain a DiscoveryService to one (or more)
102      explicit metadata sources.  (The default is to use all metadata
103      sources)
104
105  <DiscoveryServiceHandler location=".+/SecondOnly.wayf" >
106
107         <Federation identifier="SecondSite"/>
108     </DiscoveryServiceHandler>  
109 -->
110
111 </WayfConfig>