summaryrefslogtreecommitdiff
path: root/idl/parlay/fw_if_app.idl
blob: ba671e03195e101782fe69676b4636305e9420fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
//Source file: fw_if_app.idl
//Date:  13 October 2004
//Framework to Application Interfaces for ES 203 915-03 V1.1.1, DES/TISPAN-01005-03-OSA, Parlay 5.0

#ifndef __FW_IF_APP_DEFINED
#define __FW_IF_APP_DEFINED


#include "osa.idl"
#include "fw_data.idl"

module org {
	
	module csapi {
		
		module fw {
			
			module fw_application {
				
				module notification {
					
					
					interface IpAppEventNotification : IpInterface {
						void reportNotification (
							in TpFwEventInfo eventInfo,	
							in TpAssignmentID assignmentID	
							);
							
						void notificationTerminated ();
							
					};
					
					
					interface IpEventNotification : IpInterface {
						TpAssignmentID createNotification (
							in TpFwEventCriteria eventCriteria	
							)							
							raises (TpCommonExceptions,P_ACCESS_DENIED,P_INVALID_CRITERIA,P_INVALID_EVENT_TYPE);
							
						void destroyNotification (
							in TpAssignmentID assignmentID	
							)							
							raises (TpCommonExceptions,P_ACCESS_DENIED,P_INVALID_ASSIGNMENT_ID);
							
					};
					
				};
				
				module integrity {
					interface IpAppHeartBeatMgmt ;
					interface IpHeartBeat ;
					interface IpAppHeartBeat ;
					
					
					
					interface IpAppFaultManager : IpInterface {
						void activityTestRes (
							in TpActivityTestID activityTestID,	
							in TpActivityTestRes activityTestResult	
							);
							
						void appActivityTestReq (
							in TpActivityTestID activityTestID	
							);
							
						void fwFaultReportInd (
							in TpInterfaceFault fault	
							);
							
						void fwFaultRecoveryInd (
							in TpInterfaceFault fault	
							);
							
						void svcUnavailableInd (
							in TpServiceID serviceID,	
							in TpSvcUnavailReason reason	
							);
							
						void genFaultStatsRecordRes (
							in TpFaultStatsRecord faultStatistics,	
							in TpServiceIDList serviceIDs	
							);
							
						void fwUnavailableInd (
							in TpFwUnavailReason reason	
							);
							
						void activityTestErr (
							in TpActivityTestID activityTestID	
							);
							
						void genFaultStatsRecordErr (
							in TpFaultStatisticsError faultStatisticsError,	
							in TpServiceIDList serviceIDs	
							);
							
						void appUnavailableInd (
							in TpServiceID serviceID	
							);
							
						void genFaultStatsRecordReq (
							in TpTimeInterval timePeriod	
							);
							
						void svcAvailStatusInd (
							in TpServiceID serviceID,	
							in TpSvcAvailStatusReason reason	
							);
							
						void generateFaultStatisticsRecordRes (
							in TpFaultReqID faultStatsReqID,	
							in TpFaultStatsRecord faultStatistics,	
							in TpServiceIDList serviceIDs	
							);
							
						void generateFaultStatisticsRecordErr (
							in TpFaultReqID faultStatsReqID,	
							in TpFaultStatsErrorList faultStatistics,	
							in TpServiceIDList serviceIDs	
							);
							
						void generateFaultStatisticsRecordReq (
							in TpFaultReqID faultStatsReqID,	
							in TpTimeInterval timePeriod	
							);
							
						void fwAvailStatusInd (
							in TpFwAvailStatusReason reason	
							);
							
					};
					
					
					interface IpAppLoadManager : IpInterface {
						void queryAppLoadReq (
							in TpTimeInterval timeInterval	
							);
							
						void queryLoadRes (
							in TpLoadStatisticList loadStatistics	
							);
							
						void queryLoadErr (
							in TpLoadStatisticError loadStatisticsError	
							);
							
						void loadLevelNotification (
							in TpLoadStatisticList loadStatistics	
							);
							
						void resumeNotification ();
							
						void suspendNotification ();
							
						void createLoadLevelNotification ();
							
						void destroyLoadLevelNotification ();
							
						void queryAppLoadStatsReq (
							in TpLoadTestID loadStatsReqID,	
							in TpTimeInterval timeInterval	
							);
							
						void queryLoadStatsRes (
							in TpLoadTestID loadStatsReqID,	
							in TpLoadStatisticList loadStatistics	
							);
							
						void queryLoadStatsErr (
							in TpLoadTestID loadStatsReqID,	
							in TpLoadStatisticError loadStatisticsError	
							);
							
					};
					
					
					interface IpLoadManager : IpInterface {
						void reportLoad (
							in TpLoadLevel loadLevel	
							)							
							raises (TpCommonExceptions);
							
						void queryLoadReq (
							in TpServiceIDList serviceIDs,	
							in TpTimeInterval timeInterval	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_SERVICE_NOT_ENABLED,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void queryAppLoadRes (
							in TpLoadStatisticList loadStatistics	
							)							
							raises (TpCommonExceptions);
							
						void queryAppLoadErr (
							in TpLoadStatisticError loadStatisticsError	
							)							
							raises (TpCommonExceptions);
							
						void createLoadLevelNotification (
							in TpServiceIDList serviceIDs	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void destroyLoadLevelNotification (
							in TpServiceIDList serviceIDs	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void resumeNotification (
							in TpServiceIDList serviceIDs	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_SERVICE_NOT_ENABLED,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void suspendNotification (
							in TpServiceIDList serviceIDs	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_SERVICE_NOT_ENABLED,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void queryLoadStatsReq (
							in TpLoadTestID loadStatsReqID,	
							in TpServiceIDList serviceIDs,	
							in TpTimeInterval timeInterval	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_SERVICE_NOT_ENABLED,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void queryAppLoadStatsRes (
							in TpLoadTestID loadStatsReqID,	
							in TpLoadStatisticList loadStatistics	
							)							
							raises (TpCommonExceptions);
							
						void queryAppLoadStatsErr (
							in TpLoadTestID loadStatsReqID,	
							in TpLoadStatisticError loadStatisticsError	
							)							
							raises (TpCommonExceptions);
							
					};
					
					
					interface IpAppOAM : IpInterface {
						TpDateAndTime systemDateTimeQuery (
							in TpDateAndTime systemDateAndTime	
							);
							
					};
					
					
					interface IpOAM : IpInterface {
						TpDateAndTime systemDateTimeQuery (
							in TpDateAndTime clientDateAndTime	
							)							
							raises (TpCommonExceptions,P_INVALID_TIME_AND_DATE_FORMAT);
							
					};
					
					
					interface IpFaultManager : IpInterface {
						void activityTestReq (
							in TpActivityTestID activityTestID,	
							in TpServiceID svcID	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void appActivityTestRes (
							in TpActivityTestID activityTestID,	
							in TpActivityTestRes activityTestResult	
							)							
							raises (TpCommonExceptions,P_INVALID_ACTIVITY_TEST_ID);
							
						void svcUnavailableInd (
							in TpServiceID serviceID	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void genFaultStatsRecordReq (
							in TpTimeInterval timePeriod,	
							in TpServiceIDList serviceIDs	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void appActivityTestErr (
							in TpActivityTestID activityTestID	
							)							
							raises (TpCommonExceptions,P_INVALID_ACTIVITY_TEST_ID);
							
						void appUnavailableInd (
							in TpServiceID serviceID	
							)							
							raises (TpCommonExceptions);
							
						void genFaultStatsRecordRes (
							in TpFaultStatsRecord faultStatistics	
							)							
							raises (TpCommonExceptions);
							
						void genFaultStatsRecordErr (
							in TpFaultStatisticsError faultStatisticsError	
							)							
							raises (TpCommonExceptions);
							
						void appAvailStatusInd (
							in TpAppAvailStatusReason reason	
							)							
							raises (TpCommonExceptions);
							
						void generateFaultStatisticsRecordReq (
							in TpFaultReqID faultStatsReqID,	
							in TpTimeInterval timePeriod,	
							in TpServiceIDList serviceIDs	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_ID,P_UNAUTHORISED_PARAMETER_VALUE);
							
						void generateFaultStatisticsRecordRes (
							in TpFaultReqID faultStatsReqID,	
							in TpFaultStatsRecord faultStatistics	
							)							
							raises (TpCommonExceptions);
							
						void generateFaultStatisticsRecordErr (
							in TpFaultReqID faultStatsReqID,	
							in TpFaultStatisticsError faultStatisticsError	
							)							
							raises (TpCommonExceptions);
							
					};
					
					
					interface IpHeartBeatMgmt : IpInterface {
						
						void enableHeartBeat (
							in TpInt32 interval,	
							in IpAppHeartBeat appInterface	
							)							
							raises (TpCommonExceptions);
							
						void disableHeartBeat ()							
							raises (TpCommonExceptions);
							
						void changeInterval (
							in TpInt32 interval	
							)							
							raises (TpCommonExceptions);
							
					};
					
					
					interface IpAppHeartBeat : IpInterface {
						
						void pulse ();
							
					};
					
					
					interface IpHeartBeat : IpInterface {
						
						void pulse ()							
							raises (TpCommonExceptions);
							
					};
					
					
					interface IpAppHeartBeatMgmt : IpInterface {
						
						void enableAppHeartBeat (
							in TpInt32 interval,	
							in IpHeartBeat fwInterface	
							);
							
						void disableAppHeartBeat ();
							
						void changeInterval (
							in TpInt32 interval	
							);
							
					};
					
				};
				
				
				module discovery {
					
					
					interface IpServiceDiscovery : IpInterface {
						TpServiceTypeNameList listServiceTypes ()							
							raises (TpCommonExceptions,P_ACCESS_DENIED);
							
						TpServiceTypeDescription describeServiceType (
							in TpServiceTypeName name	
							)							
							raises (TpCommonExceptions,P_ACCESS_DENIED,P_ILLEGAL_SERVICE_TYPE,P_UNKNOWN_SERVICE_TYPE);
							
						TpServiceList discoverService (
							in TpServiceTypeName serviceTypeName,	
							in TpServicePropertyList desiredPropertyList,	
							in TpInt32 max	
							)							
							raises (TpCommonExceptions,P_ACCESS_DENIED,P_ILLEGAL_SERVICE_TYPE,P_UNKNOWN_SERVICE_TYPE,P_INVALID_PROPERTY);
							
						TpServiceList listSubscribedServices ()							
							raises (TpCommonExceptions,P_ACCESS_DENIED);
							
					};
					
				};
				
				module service_agreement {
					
					
					interface IpAppServiceAgreementManagement : IpInterface {
						TpOctetSet signServiceAgreement (
							in TpServiceToken serviceToken,	
							in TpString agreementText,	
							in TpSigningAlgorithm signingAlgorithm	
							)							
							raises (TpCommonExceptions,P_INVALID_AGREEMENT_TEXT,P_INVALID_SERVICE_TOKEN,P_INVALID_SIGNING_ALGORITHM);
							
						void terminateServiceAgreement (
							in TpServiceToken serviceToken,	
							in TpString terminationText,	
							in TpOctetSet digitalSignature	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_TOKEN,P_INVALID_SIGNATURE);
							
					};
					
					
					interface IpServiceAgreementManagement : IpInterface {
						TpSignatureAndServiceMgr signServiceAgreement (
							in TpServiceToken serviceToken,	
							in TpString agreementText,	
							in TpSigningAlgorithm signingAlgorithm	
							)							
							raises (TpCommonExceptions,P_ACCESS_DENIED,P_INVALID_AGREEMENT_TEXT,P_INVALID_SERVICE_TOKEN,P_INVALID_SIGNING_ALGORITHM,P_SERVICE_ACCESS_DENIED);
							
						void terminateServiceAgreement (
							in TpServiceToken serviceToken,	
							in TpString terminationText,	
							in TpOctetSet digitalSignature	
							)							
							raises (TpCommonExceptions,P_ACCESS_DENIED,P_INVALID_SERVICE_TOKEN,P_INVALID_SIGNATURE);
							
						TpServiceToken selectService (
							in TpServiceID serviceID	
							)							
							raises (TpCommonExceptions,P_ACCESS_DENIED,P_INVALID_SERVICE_ID,P_SERVICE_ACCESS_DENIED);
							
						void initiateSignServiceAgreement (
							in TpServiceToken serviceToken	
							)							
							raises (TpCommonExceptions,P_INVALID_SERVICE_TOKEN,P_SERVICE_ACCESS_DENIED);
							
					};
					
				};
				
			};			
			
		};
		
	};
	
};

#endif