17765caf7c2ae296efe228d63a95c08a0d875f08
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / Arp.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 & Release Policy
54  *  Attribute Release Policy for a User
55  *
56  * @author     Parviz Dousti (dousti@cmu.edu)
57  * @created    June, 2002
58  */
59
60
61 import java.io.*;
62 import java.util.*;
63 import java.security.Principal;
64 import java.security.acl.*;
65
66 public class Arp extends ArpCore implements Serializable{
67
68     // Attributes
69     protected String name;
70     protected boolean isAdmin;
71     private boolean everWritten = false;
72     private Date lastRead;
73     private boolean hasDefaultShar = false;
74     private ArpShar defaultShar;
75
76     // Associations
77     protected Vector  shars;
78
79     // Constructors
80     public Arp(String name, boolean isAdmin)
81         throws NotOwnerException{
82
83         this.name = name;
84         this.isAdmin = isAdmin;
85         shars  = new Vector();
86         makeAcl("arpAcl");
87     }
88
89     // Operations
90     public boolean isNew(){
91         return !everWritten;
92     }
93
94     public void setNew(boolean b){
95         everWritten = !b;
96     }
97
98     public void setLastRead(Date d){
99         lastRead = d;
100     }
101
102     public Date getLastRead(){
103         return lastRead;
104     }
105
106     /**
107      * Add a new SHAR to the list of SHARs for this ARP.
108      * returns false and does not replace if SHAR already exists.
109      */
110     public boolean addAShar(String name, boolean isDefault)
111         throws NotOwnerException,AAPermissionException, AAException{
112
113         if(isDefault && hasDefaultShar)
114             throw new AAException("Already has a Default SHAR");
115
116         ArpShar newShar = new ArpShar(name, isDefault);
117         if(shars.contains(newShar))
118             return false; // already there
119         if(! insertPermitted())
120             throw new AAPermissionException("No INSERT right for "+getCaller());
121         shars.add(newShar);
122         if(isDefault){
123             hasDefaultShar = true;
124             defaultShar = newShar;
125         }
126         return true;
127     }
128
129     /**
130      * Add the given SHAR to the list of SHARs for this ARP.
131      * returns false and does not replace if SHAR already exists.
132      */
133     public boolean addAShar(ArpShar shar)
134         throws AAPermissionException, AAException{
135
136         return addAShar(shar, false);
137     }
138
139     /**
140      * Adds the given shar to the shars for this Arp.
141      * if force flag is true and shar already exists
142      * then replaces the existing reource otherwise leaves the existing 
143      * shar untouched.  
144      * returns false if reource already existed.
145      * Throws AAPermissionException if caller is not permitted to insert or replace.
146      */
147     public boolean addAShar(ArpShar shar, boolean force)
148         throws AAPermissionException, AAException {
149                 
150         if(shars.contains(shar)){
151             if(force){
152                 if(! replacePermitted())
153                     throw new AAPermissionException("No replace right for "+getCaller());
154                 shars.remove(shar);
155                 shars.add(shar);
156             }
157             return false; // already there
158         }
159         if(! insertPermitted())
160             throw new AAPermissionException("No INSERT right for "+getCaller());
161         if(shar.isDefault() &&  hasDefaultShar)
162             throw new AAException("Already has a Default SHAR");
163
164         shars.add(shar);
165         if(shar.isDefault()){
166             hasDefaultShar = true;
167             defaultShar = shar;
168         }
169         return true;
170     }
171
172
173
174     public boolean removeAShar(String name)
175         throws NotOwnerException, AAPermissionException{
176
177         ArpShar newShar = new ArpShar(name, false);
178         if(shars.contains(newShar)){
179             if(! removePermitted())
180                 throw new AAPermissionException("No DELETE rights for "+getCaller());
181             shars.remove(newShar);
182             if(hasDefaultShar && newShar.equals(defaultShar)){
183                 defaultShar = null;
184                 hasDefaultShar = false;
185             }
186             return true;
187         }
188         return false; // not found
189     }
190
191
192     public ArpShar getShar(String name) {
193         Enumeration en = shars.elements();
194         while(en.hasMoreElements()){
195             ArpShar aShar = (ArpShar)en.nextElement();
196             if(aShar.getName().equals(name))
197                 return aShar;
198         }
199         return null;
200     }
201
202     public ArpShar[] getShars() {
203         int len = shars.size();
204         ArpShar[] a = new ArpShar[len];
205         for(int i = 0; i < len; i++)
206             a[i] = (ArpShar)shars.get(i);
207         return a;
208     }
209
210     public ArpShar getDefaultShar(){
211         return defaultShar;
212     }
213
214     public String getName(){
215         return name;
216     }
217
218     //public void setAcl(Acl acl){
219     //this.acl = acl;
220     //}
221
222     //    public String urlToShar(String url) {
223     //    }
224
225     public String toString(){
226         return name+(isAdmin?"(admin)":"");
227     }
228
229     public boolean isAdmin(){
230         return isAdmin;
231     }
232
233     public boolean equals(Object arp){
234         return name.equals(((Arp)arp).getName());
235     }
236
237 } /* end class Arp */