01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: package org.apache.catalina;
19:
20: import java.security.Principal;
21:
22: /**
23: * <p>Abstract representation of a security role, suitable for use in
24: * environments like JAAS that want to deal with <code>Principals</code>.</p>
25: *
26: * @author Craig R. McClanahan
27: * @version $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
28: * @since 4.1
29: */
30:
31: public interface Role extends Principal {
32:
33: // ------------------------------------------------------------- Properties
34:
35: /**
36: * Return the description of this role.
37: */
38: public String getDescription();
39:
40: /**
41: * Set the description of this role.
42: *
43: * @param description The new description
44: */
45: public void setDescription(String description);
46:
47: /**
48: * Return the role name of this role, which must be unique
49: * within the scope of a {@link UserDatabase}.
50: */
51: public String getRolename();
52:
53: /**
54: * Set the role name of this role, which must be unique
55: * within the scope of a {@link UserDatabase}.
56: *
57: * @param rolename The new role name
58: */
59: public void setRolename(String rolename);
60:
61: /**
62: * Return the {@link UserDatabase} within which this Role is defined.
63: */
64: public UserDatabase getUserDatabase();
65:
66: }
|