1 /* |
|
2 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of the License "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Defines permission data structure |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 #ifndef _C_PERMISSION_H_ |
|
25 #define _C_PERMISSION_H_ |
|
26 |
|
27 #include <e32debug.h> |
|
28 #include <s32strm.h> |
|
29 #include <s32mem.h> |
|
30 #include <rtsecmgrcommondef.h> |
|
31 |
|
32 typedef TUint32 TPermissionData; |
|
33 const TPermissionData LOWBIT = 0x0001; |
|
34 |
|
35 /** |
|
36 * Represents permission data structure. |
|
37 * |
|
38 * A permission data is modelled as 32 bit unsigned integer type |
|
39 * with the following layout : |
|
40 * |
|
41 * - With leftmost 20 bits representing one of symbian native capability value |
|
42 * - Bits 25 to 28 represent various user prompt conditions like oneshot, |
|
43 * session or blanket |
|
44 * - Bits 29-32 represent default condition value |
|
45 * - Bits 21-24 are reserved |
|
46 * |
|
47 * Various accessor and modifier methods are provided to access underlying |
|
48 * native capability value, the default condition and the conditions set |
|
49 * for this permission data. |
|
50 * |
|
51 * @lib rtsecmgrutil.lib |
|
52 */ |
|
53 NONSHARABLE_CLASS(CPermission) : public CBase |
|
54 { |
|
55 public: |
|
56 /** |
|
57 * Default constructor |
|
58 * |
|
59 */ |
|
60 IMPORT_C static CPermission* NewL(); |
|
61 |
|
62 /** |
|
63 * destructor |
|
64 * |
|
65 */ |
|
66 IMPORT_C ~CPermission(); |
|
67 |
|
68 /** |
|
69 * Default constructor |
|
70 * |
|
71 */ |
|
72 IMPORT_C static CPermission* NewLC(); |
|
73 |
|
74 |
|
75 /** |
|
76 * Copy constructor |
|
77 * |
|
78 * @param aPermission TPermission permission source from which copy is made |
|
79 */ |
|
80 IMPORT_C static CPermission* NewL(const CPermission& aPermission); |
|
81 |
|
82 /** |
|
83 * Copy constructor |
|
84 * |
|
85 * @param aPermission TPermission permission source from which copy is made |
|
86 */ |
|
87 IMPORT_C static CPermission* NewLC(const CPermission& aPermission); |
|
88 |
|
89 /** |
|
90 * Overloaded constructor taking capability |
|
91 * |
|
92 * @param aCapability TCapability capability to be set |
|
93 */ |
|
94 IMPORT_C static CPermission* NewL(const RCapabilityArray& aCapabilities); |
|
95 |
|
96 /** |
|
97 * Overloaded constructor taking capability |
|
98 * |
|
99 * @param aCapability TCapability capability to be set |
|
100 */ |
|
101 IMPORT_C static CPermission* NewLC(const RCapabilityArray& aCapabilities); |
|
102 |
|
103 /** |
|
104 * Overloaded constructor taking capability and default condition |
|
105 * |
|
106 * @param aCapability TCapability capability to be set |
|
107 * @param aDefaultOption TUserPromptOption Default user prompt option to be set |
|
108 */ |
|
109 IMPORT_C static CPermission* NewL(const RCapabilityArray& aCapabilities, TUserPromptOption aDefOpt); |
|
110 |
|
111 /** |
|
112 * Overloaded constructor taking capability and default condition |
|
113 * |
|
114 * @param aCapability TCapability capability to be set |
|
115 * @param aDefaultOption TUserPromptOption Default user prompt option to be set |
|
116 */ |
|
117 IMPORT_C static CPermission* NewLC(const RCapabilityArray& aCapabilities, TUserPromptOption aDefOpt); |
|
118 |
|
119 /** |
|
120 * Overloaded constructor taking capability, default condition and conditions of |
|
121 * permission |
|
122 * |
|
123 * @param aCapability TCapability capability to be set |
|
124 * @param aDefaultOption TUserPromptOption Default user prompt option to be set |
|
125 * @param aCondition TUserPromptOption Conditions to be set |
|
126 */ |
|
127 IMPORT_C static CPermission* NewL(const RCapabilityArray& aCapabilities, TUserPromptOption aDefOpt, |
|
128 TUserPromptOption aCondition); |
|
129 |
|
130 /** |
|
131 * Overloaded constructor taking capability, default condition and conditions of |
|
132 * permission |
|
133 * |
|
134 * @param aCapability TCapability capability to be set |
|
135 * @param aDefaultOption TUserPromptOption Default user prompt option to be set |
|
136 * @param aCondition TUserPromptOption Conditions to be set |
|
137 */ |
|
138 IMPORT_C static CPermission* NewLC(const RCapabilityArray& aCapabilities, TUserPromptOption aDefOpt, |
|
139 TUserPromptOption aCondition); |
|
140 |
|
141 /** |
|
142 * Returns default prompt option |
|
143 * |
|
144 * @return TUserPromptOption default condition |
|
145 */ |
|
146 IMPORT_C TUserPromptOption Default() const; |
|
147 |
|
148 /** |
|
149 * Returns condition |
|
150 * |
|
151 * @return TUserPromptOption condition |
|
152 */ |
|
153 IMPORT_C TUserPromptOption Condition() const; |
|
154 |
|
155 /** |
|
156 * Returns capability value |
|
157 * |
|
158 * @return TCapability capability value |
|
159 */ |
|
160 IMPORT_C TCapability Capability() const; |
|
161 |
|
162 /** |
|
163 * Returns capability of the permission |
|
164 * |
|
165 * @param aCapabilities RCapabilityArray& contains the capabilities |
|
166 */ |
|
167 IMPORT_C void Capabilitilites(RCapabilityArray& aCapabilities) const; |
|
168 |
|
169 /** |
|
170 * Sets default condition value |
|
171 * |
|
172 * @param aDefaultOption TUserPromptOption default condition value |
|
173 */ |
|
174 IMPORT_C void SetDefault(TUserPromptOption aDefaultOption); |
|
175 |
|
176 /** |
|
177 * Sets condition value |
|
178 * |
|
179 * @param aCondition TUserPromptOption condition value |
|
180 */ |
|
181 IMPORT_C void SetCondition(TUserPromptOption aCondition); |
|
182 |
|
183 /** |
|
184 * Sets the name of the permission |
|
185 * |
|
186 * @param aName const TDesC& value |
|
187 */ |
|
188 IMPORT_C void SetPermName(const TDesC& aName); |
|
189 |
|
190 /** |
|
191 * Returns Name of the permission |
|
192 * |
|
193 * @return const TDesC& |
|
194 */ |
|
195 IMPORT_C const TDesC& PermName() const; |
|
196 |
|
197 /** |
|
198 * Returns iPermissionData of the permission |
|
199 * |
|
200 * @return TPermission iPermissionData value |
|
201 */ |
|
202 IMPORT_C TPermissionData PermissionData() const; |
|
203 |
|
204 // --------------------------------------------------------------------------- |
|
205 // Adds a capability to permission data |
|
206 // --------------------------------------------------------------------------- |
|
207 // |
|
208 IMPORT_C void AppendCapPermData(TCapability aCap); |
|
209 |
|
210 // --------------------------------------------------------------------------- |
|
211 // Adds an unconditional capability |
|
212 // --------------------------------------------------------------------------- |
|
213 // |
|
214 IMPORT_C void SetPermissionData(TPermissionData aPermData); |
|
215 |
|
216 /** |
|
217 * Internalizes permission data from stream |
|
218 * |
|
219 * @param aInStream RReadStream input source stream |
|
220 */ |
|
221 IMPORT_C void InternalizeL(RReadStream& aInStream); |
|
222 |
|
223 /** |
|
224 * Externalizes permission data to stream |
|
225 * |
|
226 * @param aOutStream RWriteStream output stream |
|
227 */ |
|
228 IMPORT_C void ExternalizeL(RWriteStream& aOutStream) const; |
|
229 |
|
230 private: |
|
231 /* |
|
232 * Default private constructor |
|
233 */ |
|
234 inline CPermission() : iPermName(NULL), iPermissionData(0) |
|
235 {} |
|
236 |
|
237 /* |
|
238 * private copy constructor |
|
239 */ |
|
240 CPermission(const CPermission& aPermission); |
|
241 |
|
242 |
|
243 CPermission(const RCapabilityArray& aCapabilities); |
|
244 |
|
245 CPermission(const RCapabilityArray& aCapabilities, TUserPromptOption aDefOpt); |
|
246 |
|
247 CPermission(const RCapabilityArray& aCapabilities, TUserPromptOption aDefOpt,TUserPromptOption aCondition); |
|
248 |
|
249 private: |
|
250 //layout of TPermissionData |
|
251 //__________________________________________________________________________ |
|
252 //| | | | | |
|
253 //| Default | Condition | RESERVED | CAPABILITY BITS | |
|
254 //|_________________|______________|_______________|________________________| |
|
255 // |
|
256 // 32,31,30,29, 28,27,26,25, 24,23,22,21, 20,19,18,...4,3,2,1 |
|
257 // |
|
258 //underlying permission data structure |
|
259 |
|
260 |
|
261 TPermissionData iPermissionData; |
|
262 |
|
263 |
|
264 /* |
|
265 * alias group name |
|
266 */ |
|
267 HBufC* iPermName; |
|
268 |
|
269 }; |
|
270 |
|
271 #endif //_T_PERMISSION_H_ |
|
272 |
|