1 //Source file: fw_if_app.idl
2 //Date: 13 October 2004
3 //Framework to Application Interfaces for ES 203 915-03 V1.1.1, DES/TISPAN-01005-03-OSA, Parlay 5.0
5 #ifndef __FW_IF_APP_DEFINED
6 #define __FW_IF_APP_DEFINED
10 #include
"fw_data.idl"
18 module fw_application
{
23 interface IpAppEventNotification
: IpInterface
{
24 void reportNotification
(
25 in TpFwEventInfo eventInfo
,
26 in TpAssignmentID assignmentID
29 void notificationTerminated
();
34 interface IpEventNotification
: IpInterface
{
35 TpAssignmentID createNotification
(
36 in TpFwEventCriteria eventCriteria
38 raises
(TpCommonExceptions
,P_ACCESS_DENIED
,P_INVALID_CRITERIA
,P_INVALID_EVENT_TYPE
);
40 void destroyNotification
(
41 in TpAssignmentID assignmentID
43 raises
(TpCommonExceptions
,P_ACCESS_DENIED
,P_INVALID_ASSIGNMENT_ID
);
50 interface IpAppHeartBeatMgmt
;
51 interface IpHeartBeat
;
52 interface IpAppHeartBeat
;
56 interface IpAppFaultManager
: IpInterface
{
57 void activityTestRes
(
58 in TpActivityTestID activityTestID
,
59 in TpActivityTestRes activityTestResult
62 void appActivityTestReq
(
63 in TpActivityTestID activityTestID
66 void fwFaultReportInd
(
67 in TpInterfaceFault fault
70 void fwFaultRecoveryInd
(
71 in TpInterfaceFault fault
74 void svcUnavailableInd
(
75 in TpServiceID serviceID
,
76 in TpSvcUnavailReason reason
79 void genFaultStatsRecordRes
(
80 in TpFaultStatsRecord faultStatistics
,
81 in TpServiceIDList serviceIDs
84 void fwUnavailableInd
(
85 in TpFwUnavailReason reason
88 void activityTestErr
(
89 in TpActivityTestID activityTestID
92 void genFaultStatsRecordErr
(
93 in TpFaultStatisticsError faultStatisticsError
,
94 in TpServiceIDList serviceIDs
97 void appUnavailableInd
(
98 in TpServiceID serviceID
101 void genFaultStatsRecordReq
(
102 in TpTimeInterval timePeriod
105 void svcAvailStatusInd
(
106 in TpServiceID serviceID
,
107 in TpSvcAvailStatusReason reason
110 void generateFaultStatisticsRecordRes
(
111 in TpFaultReqID faultStatsReqID
,
112 in TpFaultStatsRecord faultStatistics
,
113 in TpServiceIDList serviceIDs
116 void generateFaultStatisticsRecordErr
(
117 in TpFaultReqID faultStatsReqID
,
118 in TpFaultStatsErrorList faultStatistics
,
119 in TpServiceIDList serviceIDs
122 void generateFaultStatisticsRecordReq
(
123 in TpFaultReqID faultStatsReqID
,
124 in TpTimeInterval timePeriod
127 void fwAvailStatusInd
(
128 in TpFwAvailStatusReason reason
134 interface IpAppLoadManager
: IpInterface
{
135 void queryAppLoadReq
(
136 in TpTimeInterval timeInterval
140 in TpLoadStatisticList loadStatistics
144 in TpLoadStatisticError loadStatisticsError
147 void loadLevelNotification
(
148 in TpLoadStatisticList loadStatistics
151 void resumeNotification
();
153 void suspendNotification
();
155 void createLoadLevelNotification
();
157 void destroyLoadLevelNotification
();
159 void queryAppLoadStatsReq
(
160 in TpLoadTestID loadStatsReqID
,
161 in TpTimeInterval timeInterval
164 void queryLoadStatsRes
(
165 in TpLoadTestID loadStatsReqID
,
166 in TpLoadStatisticList loadStatistics
169 void queryLoadStatsErr
(
170 in TpLoadTestID loadStatsReqID
,
171 in TpLoadStatisticError loadStatisticsError
177 interface IpLoadManager
: IpInterface
{
179 in TpLoadLevel loadLevel
181 raises
(TpCommonExceptions
);
184 in TpServiceIDList serviceIDs
,
185 in TpTimeInterval timeInterval
187 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_SERVICE_NOT_ENABLED
,P_UNAUTHORISED_PARAMETER_VALUE
);
189 void queryAppLoadRes
(
190 in TpLoadStatisticList loadStatistics
192 raises
(TpCommonExceptions
);
194 void queryAppLoadErr
(
195 in TpLoadStatisticError loadStatisticsError
197 raises
(TpCommonExceptions
);
199 void createLoadLevelNotification
(
200 in TpServiceIDList serviceIDs
202 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_UNAUTHORISED_PARAMETER_VALUE
);
204 void destroyLoadLevelNotification
(
205 in TpServiceIDList serviceIDs
207 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_UNAUTHORISED_PARAMETER_VALUE
);
209 void resumeNotification
(
210 in TpServiceIDList serviceIDs
212 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_SERVICE_NOT_ENABLED
,P_UNAUTHORISED_PARAMETER_VALUE
);
214 void suspendNotification
(
215 in TpServiceIDList serviceIDs
217 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_SERVICE_NOT_ENABLED
,P_UNAUTHORISED_PARAMETER_VALUE
);
219 void queryLoadStatsReq
(
220 in TpLoadTestID loadStatsReqID
,
221 in TpServiceIDList serviceIDs
,
222 in TpTimeInterval timeInterval
224 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_SERVICE_NOT_ENABLED
,P_UNAUTHORISED_PARAMETER_VALUE
);
226 void queryAppLoadStatsRes
(
227 in TpLoadTestID loadStatsReqID
,
228 in TpLoadStatisticList loadStatistics
230 raises
(TpCommonExceptions
);
232 void queryAppLoadStatsErr
(
233 in TpLoadTestID loadStatsReqID
,
234 in TpLoadStatisticError loadStatisticsError
236 raises
(TpCommonExceptions
);
241 interface IpAppOAM
: IpInterface
{
242 TpDateAndTime systemDateTimeQuery
(
243 in TpDateAndTime systemDateAndTime
249 interface IpOAM
: IpInterface
{
250 TpDateAndTime systemDateTimeQuery
(
251 in TpDateAndTime clientDateAndTime
253 raises
(TpCommonExceptions
,P_INVALID_TIME_AND_DATE_FORMAT
);
258 interface IpFaultManager
: IpInterface
{
259 void activityTestReq
(
260 in TpActivityTestID activityTestID
,
263 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_UNAUTHORISED_PARAMETER_VALUE
);
265 void appActivityTestRes
(
266 in TpActivityTestID activityTestID
,
267 in TpActivityTestRes activityTestResult
269 raises
(TpCommonExceptions
,P_INVALID_ACTIVITY_TEST_ID
);
271 void svcUnavailableInd
(
272 in TpServiceID serviceID
274 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_UNAUTHORISED_PARAMETER_VALUE
);
276 void genFaultStatsRecordReq
(
277 in TpTimeInterval timePeriod
,
278 in TpServiceIDList serviceIDs
280 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_UNAUTHORISED_PARAMETER_VALUE
);
282 void appActivityTestErr
(
283 in TpActivityTestID activityTestID
285 raises
(TpCommonExceptions
,P_INVALID_ACTIVITY_TEST_ID
);
287 void appUnavailableInd
(
288 in TpServiceID serviceID
290 raises
(TpCommonExceptions
);
292 void genFaultStatsRecordRes
(
293 in TpFaultStatsRecord faultStatistics
295 raises
(TpCommonExceptions
);
297 void genFaultStatsRecordErr
(
298 in TpFaultStatisticsError faultStatisticsError
300 raises
(TpCommonExceptions
);
302 void appAvailStatusInd
(
303 in TpAppAvailStatusReason reason
305 raises
(TpCommonExceptions
);
307 void generateFaultStatisticsRecordReq
(
308 in TpFaultReqID faultStatsReqID
,
309 in TpTimeInterval timePeriod
,
310 in TpServiceIDList serviceIDs
312 raises
(TpCommonExceptions
,P_INVALID_SERVICE_ID
,P_UNAUTHORISED_PARAMETER_VALUE
);
314 void generateFaultStatisticsRecordRes
(
315 in TpFaultReqID faultStatsReqID
,
316 in TpFaultStatsRecord faultStatistics
318 raises
(TpCommonExceptions
);
320 void generateFaultStatisticsRecordErr
(
321 in TpFaultReqID faultStatsReqID
,
322 in TpFaultStatisticsError faultStatisticsError
324 raises
(TpCommonExceptions
);
329 interface IpHeartBeatMgmt
: IpInterface
{
331 void enableHeartBeat
(
333 in IpAppHeartBeat appInterface
335 raises
(TpCommonExceptions
);
337 void disableHeartBeat
()
338 raises
(TpCommonExceptions
);
340 void changeInterval
(
343 raises
(TpCommonExceptions
);
348 interface IpAppHeartBeat
: IpInterface
{
355 interface IpHeartBeat
: IpInterface
{
358 raises
(TpCommonExceptions
);
363 interface IpAppHeartBeatMgmt
: IpInterface
{
365 void enableAppHeartBeat
(
367 in IpHeartBeat fwInterface
370 void disableAppHeartBeat
();
372 void changeInterval
(
384 interface IpServiceDiscovery
: IpInterface
{
385 TpServiceTypeNameList listServiceTypes
()
386 raises
(TpCommonExceptions
,P_ACCESS_DENIED
);
388 TpServiceTypeDescription describeServiceType
(
389 in TpServiceTypeName name
391 raises
(TpCommonExceptions
,P_ACCESS_DENIED
,P_ILLEGAL_SERVICE_TYPE
,P_UNKNOWN_SERVICE_TYPE
);
393 TpServiceList discoverService
(
394 in TpServiceTypeName serviceTypeName
,
395 in TpServicePropertyList desiredPropertyList
,
398 raises
(TpCommonExceptions
,P_ACCESS_DENIED
,P_ILLEGAL_SERVICE_TYPE
,P_UNKNOWN_SERVICE_TYPE
,P_INVALID_PROPERTY
);
400 TpServiceList listSubscribedServices
()
401 raises
(TpCommonExceptions
,P_ACCESS_DENIED
);
407 module service_agreement
{
410 interface IpAppServiceAgreementManagement
: IpInterface
{
411 TpOctetSet signServiceAgreement
(
412 in TpServiceToken serviceToken
,
413 in TpString agreementText
,
414 in TpSigningAlgorithm signingAlgorithm
416 raises
(TpCommonExceptions
,P_INVALID_AGREEMENT_TEXT
,P_INVALID_SERVICE_TOKEN
,P_INVALID_SIGNING_ALGORITHM
);
418 void terminateServiceAgreement
(
419 in TpServiceToken serviceToken
,
420 in TpString terminationText
,
421 in TpOctetSet digitalSignature
423 raises
(TpCommonExceptions
,P_INVALID_SERVICE_TOKEN
,P_INVALID_SIGNATURE
);
428 interface IpServiceAgreementManagement
: IpInterface
{
429 TpSignatureAndServiceMgr signServiceAgreement
(
430 in TpServiceToken serviceToken
,
431 in TpString agreementText
,
432 in TpSigningAlgorithm signingAlgorithm
434 raises
(TpCommonExceptions
,P_ACCESS_DENIED
,P_INVALID_AGREEMENT_TEXT
,P_INVALID_SERVICE_TOKEN
,P_INVALID_SIGNING_ALGORITHM
,P_SERVICE_ACCESS_DENIED
);
436 void terminateServiceAgreement
(
437 in TpServiceToken serviceToken
,
438 in TpString terminationText
,
439 in TpOctetSet digitalSignature
441 raises
(TpCommonExceptions
,P_ACCESS_DENIED
,P_INVALID_SERVICE_TOKEN
,P_INVALID_SIGNATURE
);
443 TpServiceToken selectService
(
444 in TpServiceID serviceID
446 raises
(TpCommonExceptions
,P_ACCESS_DENIED
,P_INVALID_SERVICE_ID
,P_SERVICE_ACCESS_DENIED
);
448 void initiateSignServiceAgreement
(
449 in TpServiceToken serviceToken
451 raises
(TpCommonExceptions
,P_INVALID_SERVICE_TOKEN
,P_SERVICE_ACCESS_DENIED
);