KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > catalina > users > AbstractRole


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18
19 package org.apache.catalina.users;
20
21
22 import org.apache.catalina.Role;
23 import org.apache.catalina.UserDatabase;
24
25
26 /**
27  * <p>Convenience base class for {@link Role} implementations.</p>
28  *
29  * @author Craig R. McClanahan
30  * @version $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
31  * @since 4.1
32  */
33
34 public abstract class AbstractRole implements Role {
35
36
37     // ----------------------------------------------------- Instance Variables
38
39
40     /**
41      * The description of this Role.
42      */
43     protected String JavaDoc description = null;
44
45
46     /**
47      * The role name of this Role.
48      */
49     protected String JavaDoc rolename = null;
50
51
52     // ------------------------------------------------------------- Properties
53
54
55     /**
56      * Return the description of this role.
57      */
58     public String JavaDoc getDescription() {
59
60         return (this.description);
61
62     }
63
64
65     /**
66      * Set the description of this role.
67      *
68      * @param description The new description
69      */
70     public void setDescription(String JavaDoc description) {
71
72         this.description = description;
73
74     }
75
76
77     /**
78      * Return the role name of this role, which must be unique
79      * within the scope of a {@link UserDatabase}.
80      */
81     public String JavaDoc getRolename() {
82
83         return (this.rolename);
84
85     }
86
87
88     /**
89      * Set the role name of this role, which must be unique
90      * within the scope of a {@link UserDatabase}.
91      *
92      * @param rolename The new role name
93      */
94     public void setRolename(String JavaDoc rolename) {
95
96         this.rolename = rolename;
97
98     }
99
100
101     /**
102      * Return the {@link UserDatabase} within which this Role is defined.
103      */
104     public abstract UserDatabase getUserDatabase();
105
106
107     // --------------------------------------------------------- Public Methods
108
109
110     // ------------------------------------------------------ Principal Methods
111
112
113     /**
114      * Make the principal name the same as the role name.
115      */
116     public String JavaDoc getName() {
117
118         return (getRolename());
119
120     }
121
122
123 }
124
Popular Tags