KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > joram > mom > notifications > SetRightRequest


1 /*
2  * JORAM: Java(TM) Open Reliable Asynchronous Messaging
3  * Copyright (C) 2001 - ScalAgent Distributed Technologies
4  * Copyright (C) 1996 - Dyade
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19  * USA.
20  *
21  * Initial developer(s): Frederic Maistre (INRIA)
22  * Contributor(s):
23  */
24 package org.objectweb.joram.mom.notifications;
25
26 import fr.dyade.aaa.agent.AgentId;
27
28
29 /**
30  * A <code>SetRightRequest</code> instance is used by a client agent
31  * for setting users right on a destination.
32  */
33 public class SetRightRequest extends AdminRequest
34 {
35   /** Identifier of the user, <code>null</code> stands for all users. */
36   private AgentId client;
37   /**
38    * Right to set, (-)3 for (un)setting an admin right, (-)2 for
39    * (un)setting a writing permission, (-)1 for (un)setting a reading
40    * permission, and 0 for removing all the user's permissions.
41    */
42   private int right;
43
44   
45   /**
46    * Constructs a <code>SetRightRequest</code> instance.
47    *
48    * @param id Identifier of the request, may be null.
49    * @param client AgentId of client which right is to be set,
50    * <code>null</code> for all users.
51    * @param right Right to grant, authorized values: -3, -2, -1, 1, 2, 3.
52    */
53   public SetRightRequest(String JavaDoc id, AgentId client, int right)
54   {
55     super(id);
56     this.client = client;
57     this.right = right;
58   }
59
60  
61   /** Returns the AgentId of the client which right is set. */
62   public AgentId getClient()
63   {
64     return client;
65   }
66
67   /**
68    * Returns the right to set, (-)3 for (un)setting an admin right, (-)2 for
69    * (un)setting a writing permission, (-)1 for (un)setting a reading
70    * permission, and 0 for removing all the user's permissions.
71    */
72   public int getRight()
73   {
74     return right;
75   }
76 }
77
Popular Tags