KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > browser > core > api > RoleManagement


1 /*====================================================================
2
3 Objectweb Browser framework
4 Copyright (C) 2000-2004 INRIA - USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Jerome Moroy.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26 package org.objectweb.util.browser.core.api;
27
28 /**
29  * Define a role used to define a configuration.
30  *
31  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jerome Moroy</a>
32  *
33  * @version 0.1
34  */
35 public interface RoleManagement {
36
37     /** Represent the default user (when no user is defined). */
38     public static final String JavaDoc DEFAULT_ROLE = "_Default_Role_";
39     
40     /**
41      * Provides the current role.
42      *
43      * @return The current role.
44      */
45     public Role[] getCurrentRoles();
46     
47     /**
48      * Fixes the current role.
49      *
50      * @param role_id The id of the role.
51      */
52     public void setCurrentRole(String JavaDoc[] role_id);
53
54     /**
55      * Fixes the current role.
56      *
57      * @param role The role to define as current role.
58      */
59     public void setCurrentRole(Role[] role);
60
61     /**
62      * Provides the list of all define roles.
63      *
64      * @return The list of roles.
65      */
66     public Role[] getRoleList();
67     
68 }
69
Popular Tags