KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mr > kernel > security > authorization > actions > MantaAction


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.actions;
48
49 import org.mr.kernel.security.MantaSecurityException;
50
51 import java.util.List JavaDoc;
52
53 /**
54  * This interface represents a secured action that may be performed by
55  * an authorized client. Each implementing class will have its own knowledge
56  * about which permissions are required in order for the action to be authorized.
57  *
58  * This interface has one method {@link #getPermissionSearchList(Object)} that is used
59  * by each implementing class to define the list of permissions it requires in order for
60  * the action to be authorized.
61  *
62  * @version 1.0
63  * @since May 9, 2006
64  * @author Shirley Sasson
65  *
66  */
67 public interface MantaAction {
68     /**
69      * This method is used by each implementing class to define the list of permissions it
70      * requires in order for the action to be authorized.
71      * The permissions in the list are checked according to the order of the list, and once
72      * a permission is found, the action is authorized, and the other permissions that appear
73      * after it in the list, are not checked. If all permissions were checked and not found,
74      * the action is not authorized.
75      *
76      * @param param
77      * parameter that is relevant for the permissions search. For example topic name for
78      * an "create producer for queue" action.
79      * @return a list of permissions to be searched
80      * @throws MantaSecurityException if an error occured
81      */
82     public List JavaDoc getPermissionSearchList(Object JavaDoc param) throws MantaSecurityException;
83 }
84
Popular Tags