57459bc23268a15354b978ac03209739ed481c5f
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / ArpResource.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  *  Resource (or URL) node in the ARP tree.
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.acl.*;
64
65 public class ArpResource extends ArpCore implements Serializable{
66
67     // Attributes
68     protected String name;
69
70     // Associations
71     protected TName tName;
72     protected Vector attributes;
73     protected AA_Acl acl;
74
75     // constructor
76     public ArpResource(String name) throws NotOwnerException{
77         this.name = name;
78         tName = new TName(name);
79         attributes = new Vector();
80         makeAcl("resourceAcl");
81     }
82
83     // Operations
84     public String toString() {
85         return name+" ["+tName+"]";
86     }
87
88
89     public boolean addAnAttribute(String name, boolean exclude)
90         throws AAPermissionException{
91
92         if(attributes.contains(new ArpAttribute(name, exclude)))
93             return false; // already there
94         if(! insertPermitted())
95             throw new AAPermissionException("No INSERT right for "+getCaller());
96         attributes.add(new ArpAttribute(name, exclude));
97         return true;
98     }
99
100     public boolean addAnAttribute(ArpAttribute attr)
101         throws AAPermissionException{
102         return addAnAttribute(attr, false);
103     }
104
105     /**
106      * Adds the given attribute to the attributes for this Resource.
107      * if force flag is true and attribute already exists
108      * then replaces the existing reource otherwise leaves the existing 
109      * attribute untouched.  
110      * returns false if reource already existed.
111      */
112     public boolean addAnAttribute(ArpAttribute attr, boolean force)
113         throws AAPermissionException {
114
115         if(attributes.contains(attr)){
116             if(force){
117                 if(! replacePermitted())
118                     throw new AAPermissionException("No replace right for "+getCaller());               
119                 attributes.remove(attr);
120                 attributes.add(attr);
121             }
122             return false; // already there
123         }
124         if(! insertPermitted())
125             throw new AAPermissionException("No INSERT right for "+getCaller());        
126         attributes.add(attr);
127         return true;
128     }
129
130     public boolean removeAnAttribute(String name)
131         throws AAPermissionException {
132
133         if(attributes.contains(new ArpAttribute(name, false))){
134             if(! insertPermitted())
135                 throw new AAPermissionException("No DELETE right for "+getCaller());        
136             attributes.remove(new ArpAttribute(name, false));
137             return true;
138         }
139         return false; // not found
140     }
141
142     public ArpAttribute getAttribute(String name) {
143         Enumeration en = attributes.elements();
144         while(en.hasMoreElements()){
145             ArpAttribute aAttribute = (ArpAttribute)en.nextElement();
146             if(aAttribute.getName().equals(name))
147                 return aAttribute;
148         }
149         return null;
150     }
151
152     public ArpAttribute[] getAttributes() {
153         int len = attributes.size();
154         ArpAttribute[] a = new ArpAttribute[len];
155         for(int i = 0; i < len; i++)
156             a[i] = (ArpAttribute)attributes.get(i);
157         return a;
158     }
159
160
161     public int fit(String resrcName) {
162         TName tn = new TName(resrcName);
163         return tName.compare(tn);
164     }
165
166     public TName getTName(){
167         return tName;
168     }
169
170     public String getName(){
171         return name;
172     }
173
174     public boolean equals(Object rsrc){
175         return name.equals(((ArpResource)rsrc).getName());
176     }
177
178 } /* end class ArpResource */