KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mr > kernel > security > authorization > PermissionKeyEntry


1 /*
2  * Copyright 2002 by
3  * <a HREF="http://www.coridan.com">Coridan</a>
4  * <a HREF="mailto: support@coridan.com ">support@coridan.com</a>
5  *
6  * The contents of this file are subject to the Mozilla Public License Version
7  * 1.1 (the "License"); you may not use this file except in compliance with the
8  * License. You may obtain a copy of the License at
9  * http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the
14  * License.
15  *
16  * The Original Code is "MantaRay" (TM).
17  *
18  * The Initial Developer of the Original Code is Shirley Sasson.
19  * Portions created by the Initial Developer are Copyright (C) 2006
20  * Coridan Inc. All Rights Reserved.
21  *
22  * Contributor(s): all the names of the contributors are added in the source
23  * code where applicable.
24  *
25  * Alternatively, the contents of this file may be used under the terms of the
26  * LGPL license (the "GNU LESSER GENERAL PUBLIC LICENSE"), in which case the
27  * provisions of LGPL are applicable instead of those above. If you wish to
28  * allow use of your version of this file only under the terms of the LGPL
29  * License and not to allow others to use your version of this file under
30  * the MPL, indicate your decision by deleting the provisions above and
31  * replace them with the notice and other provisions required by the LGPL.
32  * If you do not delete the provisions above, a recipient may use your version
33  * of this file under either the MPL or the GNU LESSER GENERAL PUBLIC LICENSE.
34
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Lesser General Public License as published by the Free Software Foundation;
39  * either version 2.1 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
43  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
44  * License for more details.
45  */

46
47 package org.mr.kernel.security.authorization;
48
49 import org.mr.kernel.security.MantaPrincipal;
50 import org.mr.kernel.security.authorization.permissions.MantaPermission;
51
52 /**
53  * This class represents the key object for permissions saved in the permission cache.
54  * It holds a principal and a permission.
55  *
56  * @version 1.0
57  * @since May 9, 2006
58  * @author Shirley Sasson
59  *
60  */

61 public class PermissionKeyEntry implements ACLKeyEntry {
62     private MantaPrincipal _principal;
63     private MantaPermission _permission;
64
65     /**
66      * Constructs a new instance of PermissionKeyEntry with the given principal and permission.
67      *
68      * @param principal the principal for whom the permission relates to
69      * @param permission the permission
70      *
71      */

72     public PermissionKeyEntry(MantaPrincipal principal, MantaPermission permission){
73         _principal = principal;
74         _permission = permission;
75     }
76
77     /**
78      * Returns the principal member.
79      *
80      * @return the principal member
81      *
82      */

83     public MantaPrincipal getPrincipal(){
84         return _principal;
85     }
86
87     /**
88      * Returns the permission member.
89      *
90      * @return the permission member
91      *
92      */

93     public MantaPermission getPermission(){
94         return _permission;
95     }
96
97     /**
98      * Sets the principal member with the given value.
99      *
100      * @param principal the principal
101      */

102     public void setPrincipal(MantaPrincipal principal){
103         _principal = principal;
104     }
105
106     /**
107      * Compares the specified Object with this PermissionKeyEntry for equality.
108      * Returns true if the given object is also a PermissionKeyEntry and the two PermissionKeyEntry
109      * instances have the principal and permission.
110      *
111      * @param obj - the Object to compare to
112      * @return true if the Object passed in represents the same PermissionKeyEntry as this one, false otherwise.
113      */

114     public boolean equals(Object JavaDoc obj){
115         if (!(obj instanceof PermissionKeyEntry))
116             return false;
117         PermissionKeyEntry other = (PermissionKeyEntry) obj;
118         return (_principal.equals(other._principal) && _permission.equals(other._permission));
119     }
120
121     /**
122      * Return a hash code for this PermissionKeyEntry.
123      *
124      * @return a hash code for this PermissionKeyEntry
125      * @see java.lang.Object#equals(Object)
126      */

127     public int hashCode(){
128         return _principal.hashCode() + _permission.hashCode();
129     }
130
131     /**
132      * Returns a string representation of this PermissionKeyEntry.
133      *
134      * @return a string representation of this PermissionKeyEntry.
135      */

136     public String JavaDoc toString(){
137         return _principal + "," + _permission;
138     }
139 }
140
Popular Tags