Removed redundant checking.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / common / ShibPOSTProfileFactory.java
1 /* 
2  * The Shibboleth License, Version 1. 
3  * Copyright (c) 2002 
4  * University Corporation for Advanced Internet Development, Inc. 
5  * All rights reserved
6  * 
7  * 
8  * Redistribution and use in source and binary forms, with or without 
9  * modification, are permitted provided that the following conditions are met:
10  * 
11  * Redistributions of source code must retain the above copyright notice, this 
12  * list of conditions and the following disclaimer.
13  * 
14  * Redistributions in binary form must reproduce the above copyright notice, 
15  * this list of conditions and the following disclaimer in the documentation 
16  * and/or other materials provided with the distribution, if any, must include 
17  * the following acknowledgment: "This product includes software developed by 
18  * the University Corporation for Advanced Internet Development 
19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
20  * may appear in the software itself, if and wherever such third-party 
21  * acknowledgments normally appear.
22  * 
23  * Neither the name of Shibboleth nor the names of its contributors, nor 
24  * Internet2, nor the University Corporation for Advanced Internet Development, 
25  * Inc., nor UCAID may be used to endorse or promote products derived from this 
26  * software without specific prior written permission. For written permission, 
27  * please contact shibboleth@shibboleth.org
28  * 
29  * Products derived from this software may not be called Shibboleth, Internet2, 
30  * UCAID, or the University Corporation for Advanced Internet Development, nor 
31  * may Shibboleth appear in their name, without prior written permission of the 
32  * University Corporation for Advanced Internet Development.
33  * 
34  * 
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  */
49
50 package edu.internet2.middleware.shibboleth.common;
51
52 import java.util.Collection;
53
54 import org.opensaml.SAMLException;
55 import org.opensaml.SAMLPOSTProfile;
56
57
58 /**
59  *  Used by Shibboleth HS/SHIRE to locate a Shibboleth POST profile
60  *  implementation
61  *
62  * @author     Scott Cantor
63  * @created    April 10, 2002
64  */
65 public class ShibPOSTProfileFactory
66 {
67     /**
68      *  Gets a compatible SHIRE-side profile implementation for the specified
69      *  policies
70      *
71      * @param  policies           Set of policy URIs that the implementation
72      *      must support
73      * @param  receiver           URL of SHIRE
74      * @param  ttlSeconds         Length of time in seconds allowed to elapse
75      *      from issuance of SAML response
76      * @return                    A compatible profile implementation or null if
77      *      one cannot be found
78      * @exception  SAMLException  Raised if a profile implementation cannot be
79      *      constructed from the supplied information
80      */
81     public static ShibPOSTProfile getInstance(Collection policies, String receiver, int ttlSeconds)
82         throws SAMLException
83     {
84         return new ClubShibPOSTProfile(policies, receiver, ttlSeconds);
85     }
86
87     /**
88      *  Gets a compatible HS-side profile implementation for the specified
89      *  policies
90      *
91      * @param  policies           Set of policy URIs that the implementation
92      *      must support
93      * @param  issuer             "Official" name of issuing origin site
94      * @return                    A compatible profile implementation or null if
95      *      one cannot be found
96      * @exception  SAMLException  Raised if a profile implementation cannot be
97      *      constructed from the supplied information
98      */
99     public static ShibPOSTProfile getInstance(Collection policies, String issuer)
100         throws SAMLException
101     {
102         return new ClubShibPOSTProfile(policies, issuer);
103     }
104 }
105