/FSKit/Source/Common/enunciate/dev/identity.h

  1//
  2// This code was generated by Enunciate.
  3// http://enunciate.codehaus.org/
  4//
  5#import <libxml/xmlwriter.h>
  6#import <libxml/xmlreader.h>
  7#import <Foundation/Foundation.h>
  8#import "enunciate_common.h"
  9#import "fsv1.h"
 10
 11#ifndef DEBUG_ENUNCIATE
 12//turn off enunciate debugging.
 13#define DEBUG_ENUNCIATE 2
 14#endif
 15
 16
 17/**
 18 * (no documentation provided)
 19 */
 20enum FSIDENTITYV2AAuthenticationStatus
 21{
 22
 23  /**
 24   * (no documentation provided)
 25   */
 26  IDENTITY_IDENTITY_V2_AUTHENTICATIONSTATUS_SUCCESS,
 27
 28  /**
 29   * (no documentation provided)
 30   */
 31  IDENTITY_IDENTITY_V2_AUTHENTICATIONSTATUS_FAILURE,
 32
 33  /**
 34   * (no documentation provided)
 35   */
 36  IDENTITY_IDENTITY_V2_AUTHENTICATIONSTATUS_RESOLUTION_REQUIRED,
 37
 38  /**
 39   * (no documentation provided)
 40   */
 41  IDENTITY_IDENTITY_V2_AUTHENTICATIONSTATUS_INVALID_KEY,
 42
 43  /**
 44   * (no documentation provided)
 45   */
 46  IDENTITY_IDENTITY_V2_AUTHENTICATIONSTATUS_OTHER
 47};
 48
 49/**
 50 * Reads a AuthenticationStatus from XML. The reader is assumed to be at the start element.
 51 *
 52 * @param reader The XML reader.
 53 * @return The AuthenticationStatus, or NULL if unable to be read.
 54 */
 55static enum FSIDENTITYV2AAuthenticationStatus *xmlTextReaderReadFSIDENTITYV2AAuthenticationStatusType(xmlTextReaderPtr reader);
 56
 57/**
 58 * Writes a AuthenticationStatus to XML.
 59 *
 60 * @param writer The XML writer.
 61 * @param _authenticationStatus The AuthenticationStatus to write.
 62 * @return The bytes written (may be 0 in case of buffering) or -1 in case of error.
 63 */
 64static int xmlTextWriterWriteFSIDENTITYV2AAuthenticationStatusType(xmlTextWriterPtr writer, enum FSIDENTITYV2AAuthenticationStatus *_authenticationStatus);
 65
 66@class FSIDENTITYV2ASession;
 67@class FSIDENTITYV2AAuthentication;
 68@class FSIDENTITYV2AUserPermission;
 69@class FSIDENTITYV2AUser;
 70@class FSIDENTITYV2ASessionValue;
 71@class FSIDENTITYV1Session;
 72@class FSV1BasicProperty;
 73@class FSV1BasicError;
 74@class FSV1BasicElement;
 75@class FSIDENTITYV2AIdentityStatus;
 76@class FSIDENTITYV2AIdentityProperty;
 77@class FSIDENTITYV1Identity;
 78@class FSIDENTITYV2AIdentity;
 79
 80
 81/**
 82 * (no documentation provided)
 83 */
 84@interface FSIDENTITYV2ASession : NSObject
 85{
 86  @private
 87    NSString *_id;
 88    NSArray *_values;
 89}
 90
 91/**
 92 * session id.
 93 */
 94- (NSString *) id;
 95
 96/**
 97 * session id.
 98 */
 99- (void) setId: (NSString *) newId;
100
101/**
102 * session values.
103 */
104- (NSArray *) values;
105
106/**
107 * session values.
108 */
109- (void) setValues: (NSArray *) newValues;
110@end /* interface FSIDENTITYV2ASession */
111
112/**
113 * (no documentation provided)
114 */
115@interface FSIDENTITYV2AAuthentication : NSObject
116{
117  @private
118    enum FSIDENTITYV2AAuthenticationStatus *_status;
119    NSString *_resolutionUri;
120}
121
122/**
123 * authentication status.
124 */
125- (enum FSIDENTITYV2AAuthenticationStatus *) status;
126
127/**
128 * authentication status.
129 */
130- (void) setStatus: (enum FSIDENTITYV2AAuthenticationStatus *) newStatus;
131
132/**
133 * authentication resolution URI.
134 */
135- (NSString *) resolutionUri;
136
137/**
138 * authentication resolution URI.
139 */
140- (void) setResolutionUri: (NSString *) newResolutionUri;
141@end /* interface FSIDENTITYV2AAuthentication */
142
143/**
144 *  @author Rob Lyon
145
146 */
147@interface FSIDENTITYV2AUserPermission : NSObject
148{
149  @private
150    NSString *_id;
151    NSString *_name;
152}
153
154/**
155 * (no documentation provided)
156 */
157- (NSString *) id;
158
159/**
160 * (no documentation provided)
161 */
162- (void) setId: (NSString *) newId;
163
164/**
165 * (no documentation provided)
166 */
167- (NSString *) name;
168
169/**
170 * (no documentation provided)
171 */
172- (void) setName: (NSString *) newName;
173@end /* interface FSIDENTITYV2AUserPermission */
174
175/**
176 * (no documentation provided)
177 */
178@interface FSIDENTITYV2AUser : NSObject
179{
180  @private
181    NSString *_id;
182    NSString *_displayName;
183    NSString *_email;
184}
185
186/**
187 * (no documentation provided)
188 */
189- (NSString *) id;
190
191/**
192 * (no documentation provided)
193 */
194- (void) setId: (NSString *) newId;
195
196/**
197 * (no documentation provided)
198 */
199- (NSString *) displayName;
200
201/**
202 * (no documentation provided)
203 */
204- (void) setDisplayName: (NSString *) newDisplayName;
205
206/**
207 * (no documentation provided)
208 */
209- (NSString *) email;
210
211/**
212 * (no documentation provided)
213 */
214- (void) setEmail: (NSString *) newEmail;
215@end /* interface FSIDENTITYV2AUser */
216
217/**
218 * (no documentation provided)
219 */
220@interface FSIDENTITYV2ASessionValue : NSObject
221{
222  @private
223    NSString *_name;
224    NSString *_value;
225}
226
227/**
228 * session value name.
229 */
230- (NSString *) name;
231
232/**
233 * session value name.
234 */
235- (void) setName: (NSString *) newName;
236
237/**
238 * session value value.
239 */
240- (NSString *) value;
241
242/**
243 * session value value.
244 */
245- (void) setValue: (NSString *) newValue;
246@end /* interface FSIDENTITYV2ASessionValue */
247
248/**
249 *  A identity session.
250
251 @author Rob Lyon
252
253 */
254@interface FSIDENTITYV1Session : NSObject
255{
256  @private
257    NSString *_id;
258}
259
260/**
261 * The id of the session.
262 */
263- (NSString *) id;
264
265/**
266 * The id of the session.
267 */
268- (void) setId: (NSString *) newId;
269@end /* interface FSIDENTITYV1Session */
270
271
272/**
273 *  @author Ryan Heaton
274
275 */
276@interface FSIDENTITYV2AIdentityStatus : NSObject
277{
278  @private
279    int _code;
280    int *_subcode;
281    NSString *_message;
282    NSString *_details;
283}
284
285/**
286 * (no documentation provided)
287 */
288- (int) code;
289
290/**
291 * (no documentation provided)
292 */
293- (void) setCode: (int) newCode;
294
295/**
296 * (no documentation provided)
297 */
298- (int *) subcode;
299
300/**
301 * (no documentation provided)
302 */
303- (void) setSubcode: (int *) newSubcode;
304
305/**
306 * (no documentation provided)
307 */
308- (NSString *) message;
309
310/**
311 * (no documentation provided)
312 */
313- (void) setMessage: (NSString *) newMessage;
314
315/**
316 * (no documentation provided)
317 */
318- (NSString *) details;
319
320/**
321 * (no documentation provided)
322 */
323- (void) setDetails: (NSString *) newDetails;
324@end /* interface FSIDENTITYV2AIdentityStatus */
325
326/**
327 *  @author Ryan Heaton
328
329 */
330@interface FSIDENTITYV2AIdentityProperty : NSObject
331{
332  @private
333    NSString *_name;
334    NSString *_value;
335}
336
337/**
338 * (no documentation provided)
339 */
340- (NSString *) name;
341
342/**
343 * (no documentation provided)
344 */
345- (void) setName: (NSString *) newName;
346
347/**
348 * (no documentation provided)
349 */
350- (NSString *) value;
351
352/**
353 * (no documentation provided)
354 */
355- (void) setValue: (NSString *) newValue;
356@end /* interface FSIDENTITYV2AIdentityProperty */
357
358/**
359 *  @author Ryan Heaton
360
361 */
362@interface FSIDENTITYV1Identity : FSV1BasicElement <EnunciateXML>
363{
364  @private
365    FSIDENTITYV1Session *_session;
366}
367
368/**
369 * The session associated with the identity.
370 */
371- (FSIDENTITYV1Session *) session;
372
373/**
374 * The session associated with the identity.
375 */
376- (void) setSession: (FSIDENTITYV1Session *) newSession;
377@end /* interface FSIDENTITYV1Identity */
378
379/**
380 *  @author Brian Pugh
381
382 */
383@interface FSIDENTITYV2AIdentity : NSObject <EnunciateXML>
384{
385  @private
386    int *_statusCode;
387    BOOL *_deprecated;
388    NSString *_statusMessage;
389    NSString *_version;
390    FSIDENTITYV2AAuthentication *_authentication;
391    FSIDENTITYV2ASession *_session;
392    NSArray *_status;
393    NSArray *_users;
394    NSArray *_properties;
395    NSArray *_permissions;
396}
397
398/**
399 * (no documentation provided)
400 */
401- (int *) statusCode;
402
403/**
404 * (no documentation provided)
405 */
406- (void) setStatusCode: (int *) newStatusCode;
407
408/**
409 * (no documentation provided)
410 */
411- (BOOL *) deprecated;
412
413/**
414 * (no documentation provided)
415 */
416- (void) setDeprecated: (BOOL *) newDeprecated;
417
418/**
419 * (no documentation provided)
420 */
421- (NSString *) statusMessage;
422
423/**
424 * (no documentation provided)
425 */
426- (void) setStatusMessage: (NSString *) newStatusMessage;
427
428/**
429 * (no documentation provided)
430 */
431- (NSString *) version;
432
433/**
434 * (no documentation provided)
435 */
436- (void) setVersion: (NSString *) newVersion;
437
438/**
439 * authentication information.
440 */
441- (FSIDENTITYV2AAuthentication *) authentication;
442
443/**
444 * authentication information.
445 */
446- (void) setAuthentication: (FSIDENTITYV2AAuthentication *) newAuthentication;
447
448/**
449 * session information.
450 */
451- (FSIDENTITYV2ASession *) session;
452
453/**
454 * session information.
455 */
456- (void) setSession: (FSIDENTITYV2ASession *) newSession;
457
458/**
459 * The status list.
460 */
461- (NSArray *) status;
462
463/**
464 * The status list.
465 */
466- (void) setStatus: (NSArray *) newStatus;
467
468/**
469 * users.
470 */
471- (NSArray *) users;
472
473/**
474 * users.
475 */
476- (void) setUsers: (NSArray *) newUsers;
477
478/**
479 * The properties.
480 */
481- (NSArray *) properties;
482
483/**
484 * The properties.
485 */
486- (void) setProperties: (NSArray *) newProperties;
487
488/**
489 * permissions.
490 */
491- (NSArray *) permissions;
492
493/**
494 * permissions.
495 */
496- (void) setPermissions: (NSArray *) newPermissions;
497@end /* interface FSIDENTITYV2AIdentity */