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