KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > catalina > Role


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;
20
21
22 import java.security.Principal JavaDoc;
23
24
25 /**
26  * <p>Abstract representation of a security role, suitable for use in
27  * environments like JAAS that want to deal with <code>Principals</code>.</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 interface Role extends Principal JavaDoc {
35
36
37     // ------------------------------------------------------------- Properties
38
39
40     /**
41      * Return the description of this role.
42      */
43     public String JavaDoc getDescription();
44
45
46     /**
47      * Set the description of this role.
48      *
49      * @param description The new description
50      */
51     public void setDescription(String JavaDoc description);
52
53
54     /**
55      * Return the role name of this role, which must be unique
56      * within the scope of a {@link UserDatabase}.
57      */
58     public String JavaDoc getRolename();
59
60
61     /**
62      * Set the role name of this role, which must be unique
63      * within the scope of a {@link UserDatabase}.
64      *
65      * @param rolename The new role name
66      */
67     public void setRolename(String JavaDoc rolename);
68
69
70     /**
71      * Return the {@link UserDatabase} within which this Role is defined.
72      */
73     public UserDatabase getUserDatabase();
74
75
76 }
77
Popular Tags