1 //Source file: fw_if_service.idl
2 //Date: 13 October 2004
3 //Framework to Service Interfaces for ES 203 915-03 V1.1.1, DES/TISPAN-01005-03-OSA, Parlay 5.0
5 #ifndef __FW_IF_SERVICE_DEFINED
6 #define __FW_IF_SERVICE_DEFINED
22 interface IpFwServiceDiscovery
: IpInterface
{
23 TpServiceTypeNameList listServiceTypes
()
24 raises
(TpCommonExceptions
);
26 TpServiceTypeDescription describeServiceType
(
27 in TpServiceTypeName name
29 raises
(TpCommonExceptions
,P_ILLEGAL_SERVICE_TYPE
,P_UNKNOWN_SERVICE_TYPE
);
31 TpServiceList discoverService
(
32 in TpServiceTypeName serviceTypeName
,
33 in TpServicePropertyList desiredPropertyList
,
36 raises
(TpCommonExceptions
,P_ILLEGAL_SERVICE_TYPE
,P_UNKNOWN_SERVICE_TYPE
,P_INVALID_PROPERTY
);
38 TpServiceList listRegisteredServices
()
39 raises
(TpCommonExceptions
);
45 module service_lifecycle
{
48 interface IpServiceInstanceLifecycleManager
: IpInterface
{
49 IpService createServiceManager
(
50 in TpClientAppID application
,
51 in TpServicePropertyList serviceProperties
,
52 in TpServiceInstanceID serviceInstanceID
54 raises
(TpCommonExceptions
,P_INVALID_PROPERTY
);
56 void destroyServiceManager
(
57 in TpServiceInstanceID serviceInstance
59 raises
(TpCommonExceptions
);
65 module service_registration
{
68 interface IpFwServiceRegistration
: IpInterface
{
69 TpServiceID registerService
(
70 in TpServiceTypeName serviceTypeName
,
71 in TpServicePropertyList servicePropertyList
73 raises
(TpCommonExceptions
,P_PROPERTY_TYPE_MISMATCH
,P_DUPLICATE_PROPERTY_NAME
,P_ILLEGAL_SERVICE_TYPE
,P_UNKNOWN_SERVICE_TYPE
,P_MISSING_MANDATORY_PROPERTY
,P_SERVICE_TYPE_UNAVAILABLE
);
75 void announceServiceAvailability
(
76 in TpServiceID serviceID
,
77 in service_lifecycle
::IpServiceInstanceLifecycleManager serviceInstanceLifecycleManagerRef
79 raises
(TpCommonExceptions
,P_ILLEGAL_SERVICE_ID
,P_UNKNOWN_SERVICE_ID
,P_INVALID_INTERFACE_TYPE
);
81 void unregisterService
(
82 in TpServiceID serviceID
84 raises
(TpCommonExceptions
,P_ILLEGAL_SERVICE_ID
,P_UNKNOWN_SERVICE_ID
);
86 TpServiceDescription describeService
(
87 in TpServiceID serviceID
89 raises
(TpCommonExceptions
,P_ILLEGAL_SERVICE_ID
,P_UNKNOWN_SERVICE_ID
);
91 void unannounceService
(
92 in TpServiceID serviceID
94 raises
(TpCommonExceptions
,P_ILLEGAL_SERVICE_ID
,P_UNKNOWN_SERVICE_ID
);
96 TpServiceID registerServiceSubType
(
97 in TpServiceTypeName serviceTypeName
,
98 in TpServicePropertyList servicePropertyList
,
99 in TpServiceTypePropertyValueList extendedServicePropertyList
101 raises
(TpCommonExceptions
,P_PROPERTY_TYPE_MISMATCH
,P_DUPLICATE_PROPERTY_NAME
,P_ILLEGAL_SERVICE_TYPE
,P_UNKNOWN_SERVICE_TYPE
,P_MISSING_MANDATORY_PROPERTY
,P_SERVICE_TYPE_UNAVAILABLE
);
108 interface IpSvcHeartBeatMgmt
;
109 interface IpFwHeartBeat
;
110 interface IpSvcHeartBeat
;
114 interface IpSvcLoadManager
: IpInterface
{
115 void querySvcLoadReq
(
116 in TpTimeInterval timeInterval
118 raises
(TpCommonExceptions
);
121 in TpLoadStatisticList loadStatistics
123 raises
(TpCommonExceptions
);
126 in TpLoadStatisticError loadStatisticsError
128 raises
(TpCommonExceptions
);
130 void loadLevelNotification
(
131 in TpLoadStatisticList loadStatistics
133 raises
(TpCommonExceptions
);
135 void suspendNotification
()
136 raises
(TpCommonExceptions
);
138 void resumeNotification
()
139 raises
(TpCommonExceptions
);
141 void createLoadLevelNotification
()
142 raises
(TpCommonExceptions
);
144 void destroyLoadLevelNotification
()
145 raises
(TpCommonExceptions
);
147 void querySvcLoadStatsReq
(
148 in TpLoadTestID loadStatsReqID
,
149 in TpTimeInterval timeInterval
151 raises
(TpCommonExceptions
);
153 void queryLoadStatsRes
(
154 in TpLoadTestID loadStatsReqID
,
155 in TpLoadStatisticList loadStatistics
157 raises
(TpCommonExceptions
);
159 void queryLoadStatsErr
(
160 in TpLoadTestID loadStatsReqID
,
161 in TpLoadStatisticError loadStatisticsError
163 raises
(TpCommonExceptions
);
168 interface IpFwLoadManager
: IpInterface
{
170 in TpLoadLevel loadLevel
172 raises
(TpCommonExceptions
);
175 in TpSubjectType querySubject
,
176 in TpTimeInterval timeInterval
178 raises
(TpCommonExceptions
);
180 void querySvcLoadRes
(
181 in TpLoadStatisticList loadStatistics
183 raises
(TpCommonExceptions
);
185 void querySvcLoadErr
(
186 in TpLoadStatisticError loadStatisticError
188 raises
(TpCommonExceptions
);
190 void createLoadLevelNotification
(
191 in TpSubjectType notificationSubject
193 raises
(TpCommonExceptions
);
195 void destroyLoadLevelNotification
(
196 in TpSubjectType notificationSubject
198 raises
(TpCommonExceptions
);
200 void suspendNotification
(
201 in TpSubjectType notificationSubject
203 raises
(TpCommonExceptions
);
205 void resumeNotification
(
206 in TpSubjectType notificationSubject
208 raises
(TpCommonExceptions
);
210 void queryLoadStatsReq
(
211 in TpLoadTestID loadStatsReqID
,
212 in TpSubjectType querySubject
,
213 in TpTimeInterval timeInterval
215 raises
(TpCommonExceptions
);
217 void querySvcLoadStatsRes
(
218 in TpLoadTestID loadStatsReqID
,
219 in TpLoadStatisticList loadStatistics
221 raises
(TpCommonExceptions
);
223 void querySvcLoadStatsErr
(
224 in TpLoadTestID loadStatsReqID
,
225 in TpLoadStatisticError loadStatisticError
227 raises
(TpCommonExceptions
);
232 interface IpSvcFaultManager
: IpInterface
{
233 void activityTestRes
(
234 in TpActivityTestID activityTestID
,
235 in TpActivityTestRes activityTestResult
237 raises
(TpCommonExceptions
,P_INVALID_ACTIVITY_TEST_ID
);
239 void svcActivityTestReq
(
240 in TpActivityTestID activityTestID
242 raises
(TpCommonExceptions
);
244 void fwFaultReportInd
(
245 in TpInterfaceFault fault
247 raises
(TpCommonExceptions
);
249 void fwFaultRecoveryInd
(
250 in TpInterfaceFault fault
252 raises
(TpCommonExceptions
);
254 void fwUnavailableInd
(
255 in TpFwUnavailReason reason
257 raises
(TpCommonExceptions
);
259 void svcUnavailableInd
()
260 raises
(TpCommonExceptions
);
262 void appUnavailableInd
()
263 raises
(TpCommonExceptions
);
265 void genFaultStatsRecordRes
(
266 in TpFaultStatsRecord faultStatistics
,
267 in TpSubjectType recordSubject
269 raises
(TpCommonExceptions
);
271 void activityTestErr
(
272 in TpActivityTestID activityTestID
274 raises
(TpCommonExceptions
,P_INVALID_ACTIVITY_TEST_ID
);
276 void genFaultStatsRecordErr
(
277 in TpFaultStatisticsError faultStatisticsError
,
278 in TpSubjectType recordSubject
280 raises
(TpCommonExceptions
);
282 void genFaultStatsRecordReq
(
283 in TpTimeInterval timePeriod
,
284 in TpServiceIDList serviceIDs
286 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_UNAUTHORISED_PARAMETER_VALUE
);
288 void generateFaultStatsRecordReq
(
289 in TpTimeInterval timePeriod
291 raises
(TpCommonExceptions
);
293 void appAvailStatusInd
(
294 in TpAppAvailStatusReason reason
296 raises
(TpCommonExceptions
);
298 void generateFaultStatisticsRecordRes
(
299 in TpFaultReqID faultStatsReqID
,
300 in TpFaultStatsRecord faultStatistics
,
301 in TpSubjectType recordSubject
303 raises
(TpCommonExceptions
);
305 void generateFaultStatisticsRecordErr
(
306 in TpFaultReqID faultStatsReqID
,
307 in TpFaultStatisticsError faultStatisticsError
,
308 in TpSubjectType recordSubject
310 raises
(TpCommonExceptions
);
312 void generateFaultStatisticsRecordReq
(
313 in TpFaultReqID faultStatsReqID
,
314 in TpTimeInterval timePeriod
316 raises
(TpCommonExceptions
);
318 void fwAvailStatusInd
(
319 in TpFwAvailStatusReason reason
325 interface IpFwFaultManager
: IpInterface
{
326 void activityTestReq
(
327 in TpActivityTestID activityTestID
,
328 in TpSubjectType testSubject
330 raises
(TpCommonExceptions
);
332 void svcActivityTestRes
(
333 in TpActivityTestID activityTestID
,
334 in TpActivityTestRes activityTestResult
336 raises
(TpCommonExceptions
,P_INVALID_ACTIVITY_TEST_ID
);
338 void appUnavailableInd
()
339 raises
(TpCommonExceptions
);
341 void genFaultStatsRecordReq
(
342 in TpTimeInterval timePeriod
,
343 in TpSubjectType recordSubject
345 raises
(TpCommonExceptions
);
347 void svcUnavailableInd
(
348 in TpSvcUnavailReason reason
350 raises
(TpCommonExceptions
);
352 void svcActivityTestErr
(
353 in TpActivityTestID activityTestID
355 raises
(TpCommonExceptions
,P_INVALID_ACTIVITY_TEST_ID
);
357 void genFaultStatsRecordRes
(
358 in TpFaultStatsRecord faultStatistics
,
359 in TpServiceIDList serviceIDs
361 raises
(TpCommonExceptions
);
363 void genFaultStatsRecordErr
(
364 in TpFaultStatisticsError faultStatisticsError
,
365 in TpServiceIDList serviceIDs
367 raises
(TpCommonExceptions
);
369 void generateFaultStatsRecordRes
(
370 in TpFaultStatsRecord faultStatistics
372 raises
(TpCommonExceptions
);
374 void generateFaultStatsRecordErr
(
375 in TpFaultStatisticsError faultStatisticsError
377 raises
(TpCommonExceptions
);
379 void svcAvailStatusInd
(
380 in TpSvcAvailStatusReason reason
382 raises
(TpCommonExceptions
);
384 void generateFaultStatisticsRecordReq
(
385 in TpFaultReqID faultStatsReqID
,
386 in TpTimeInterval timePeriod
,
387 in TpSubjectType recordSubject
389 raises
(TpCommonExceptions
);
391 void generateFaultStatisticsRecordRes
(
392 in TpFaultReqID faultStatsReqID
,
393 in TpFaultStatsRecord faultStatistics
395 raises
(TpCommonExceptions
);
397 void generateFaultStatisticsRecordErr
(
398 in TpFaultReqID faultStatsReqID
,
399 in TpFaultStatisticsError faultStatisticsError
401 raises
(TpCommonExceptions
);
406 interface IpSvcOAM
: IpInterface
{
407 TpDateAndTime systemDateTimeQuery
(
408 in TpDateAndTime systemDateAndTime
410 raises
(TpCommonExceptions
,P_INVALID_TIME_AND_DATE_FORMAT
);
415 interface IpFwOAM
: IpInterface
{
416 TpDateAndTime systemDateTimeQuery
(
417 in TpDateAndTime clientDateAndTime
419 raises
(TpCommonExceptions
,P_INVALID_TIME_AND_DATE_FORMAT
);
424 interface IpFwHeartBeatMgmt
: IpInterface
{
426 void enableHeartBeat
(
428 in IpSvcHeartBeat svcInterface
430 raises
(TpCommonExceptions
,P_INVALID_INTERFACE_TYPE
);
432 void disableHeartBeat
()
433 raises
(TpCommonExceptions
);
435 void changeInterval
(
438 raises
(TpCommonExceptions
);
443 interface IpSvcHeartBeat
: IpInterface
{
446 raises
(TpCommonExceptions
);
451 interface IpFwHeartBeat
: IpInterface
{
454 raises
(TpCommonExceptions
);
459 interface IpSvcHeartBeatMgmt
: IpInterface
{
461 void enableSvcHeartBeat
(
463 in IpFwHeartBeat fwInterface
465 raises
(TpCommonExceptions
,P_INVALID_INTERFACE_TYPE
);
467 void disableSvcHeartBeat
()
468 raises
(TpCommonExceptions
);
470 void changeInterval
(
473 raises
(TpCommonExceptions
);
479 module notification
{
482 interface IpFwEventNotification
: IpInterface
{
483 TpAssignmentID createNotification
(
484 in TpFwEventCriteria eventCriteria
486 raises
(TpCommonExceptions
,P_INVALID_EVENT_TYPE
,P_INVALID_CRITERIA
);
488 void destroyNotification
(
489 in TpAssignmentID assignmentID
491 raises
(TpCommonExceptions
,P_INVALID_ASSIGNMENT_ID
);
496 interface IpSvcEventNotification
: IpInterface
{
497 void reportNotification
(
498 in TpFwEventInfo eventInfo
,
499 in TpAssignmentID assignmentID
501 raises
(TpCommonExceptions
,P_INVALID_ASSIGNMENT_ID
);
503 void notificationTerminated
()
504 raises
(TpCommonExceptions
);