Remove throws clause on constructor, since it can't possibly throw any exceptions.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / AAResponder.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.aa;
51
52 /**
53  *  Attribute Authority &amp; Release Policy
54  *  Main logic that decides what to release 
55  *
56  * @author     Parviz Dousti (dousti@cmu.edu)
57  * @author     Walter Hoehn (wassa@columbia.edu)
58  */
59
60 import java.net.URI;
61 import java.net.URL;
62 import java.security.Principal;
63
64 import org.apache.log4j.Logger;
65 import org.opensaml.SAMLAttribute;
66 import org.opensaml.SAMLException;
67
68 import edu.internet2.middleware.shibboleth.aa.arp.ArpEngine;
69 import edu.internet2.middleware.shibboleth.aa.arp.ArpProcessingException;
70 import edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolver;
71
72 public class AAResponder {
73
74         private ArpEngine arpEngine;
75         private AttributeResolver resolver;
76         private static Logger log = Logger.getLogger(AAResponder.class.getName());
77
78         public AAResponder(ArpEngine arpEngine, AttributeResolver resolver) {
79
80                 this.arpEngine = arpEngine;
81                 this.resolver = resolver;
82         }
83
84         public SAMLAttribute[] getReleaseAttributes(Principal principal, String requester, URL resource)
85                 throws AAException {
86
87                 try {
88                         URI[] potentialAttributes = arpEngine.listPossibleReleaseAttributes(principal, requester, resource);
89                         return getReleaseAttributes(principal, requester, resource, potentialAttributes);
90
91                 } catch (ArpProcessingException e) {
92                         log.error(
93                                 "An error occurred while processing the ARPs for principal ("
94                                         + principal.getName()
95                                         + ") :"
96                                         + e.getMessage());
97                         throw new AAException("Error retrieving data for principal.");
98                 }
99         }
100         
101         public SAMLAttribute[] getReleaseAttributes(
102                 Principal principal,
103                 String requester,
104                 URL resource,
105                 URI[] attributeNames)
106                 throws AAException {
107
108                 try {
109                         AAAttributeSet attributeSet = new AAAttributeSet();
110                         for (int i = 0; i < attributeNames.length; i++) {
111                                 AAAttribute attribute = new AAAttribute(attributeNames[i].toString());
112                                 attributeSet.add(attribute);
113                         }
114
115                         return resolveAttributes(principal, requester, resource, attributeSet);
116
117                 } catch (SAMLException e) {
118                         log.error(
119                                 "An error occurred while creating attributes for principal ("
120                                         + principal.getName()
121                                         + ") :"
122                                         + e.getMessage());
123                         throw new AAException("Error retrieving data for principal.");
124
125                 } catch (ArpProcessingException e) {
126                         log.error(
127                                 "An error occurred while processing the ARPs for principal ("
128                                         + principal.getName()
129                                         + ") :"
130                                         + e.getMessage());
131                         throw new AAException("Error retrieving data for principal.");
132                 }
133         }
134
135         private SAMLAttribute[] resolveAttributes(
136                 Principal principal,
137                 String requester,
138                 URL resource,
139                 AAAttributeSet attributeSet)
140                 throws ArpProcessingException {
141
142                 resolver.resolveAttributes(principal, requester, attributeSet);
143                 arpEngine.filterAttributes(attributeSet, principal, requester, resource);
144                 return attributeSet.getAttributes();
145         }
146
147         /**
148          * Cleanup resources that won't be released when this object is garbage-collected
149          */
150         public void destroy() {
151                 resolver.destroy();
152                 arpEngine.destroy();
153         }
154 }