1 //Source file: fw_data.idl
2 //Date: 13 October 2004
3 //Framework Data Types for ES 203 915-03 V1.1.1, DES/TISPAN-01005-03-OSA, Parlay 5.0
5 #ifndef __FW_DATA_DEFINED
6 #define __FW_DATA_DEFINED
17 typedef TpString TpAccessType
;
20 typedef TpInt32 TpActivityTestID
;
23 typedef TpString TpActivityTestRes
;
26 enum TpAPIUnavailReason
{
28 API_UNAVAILABLE_UNDEFINED
,
29 API_UNAVAILABLE_LOCAL_FAILURE
,
30 API_UNAVAILABLE_GATEWAY_FAILURE
,
31 API_UNAVAILABLE_OVERLOADED
,
32 API_UNAVAILABLE_CLOSED
,
33 API_UNAVAILABLE_PROTOCOL_FAILURE
37 typedef TpString TpEncryptionCapability
;
40 typedef TpString TpEncryptionCapabilityList
;
43 typedef TpString TpAuthType
;
46 typedef TpString TpClientAppID
;
49 typedef sequence
<TpClientAppID
> TpClientAppIDList
;
62 typedef TpString TpEmail
;
65 typedef TpString TpEntOpID
;
68 typedef sequence
<TpEntOpID
> TpEntOpIDList
;
73 P_EVENT_FW_NAME_UNDEFINED
,
74 P_EVENT_FW_SERVICE_AVAILABLE
,
75 P_EVENT_FW_SERVICE_UNAVAILABLE
,
76 P_EVENT_FW_MIGRATION_SERVICE_AVAILABLE
,
77 P_EVENT_FW_APP_SESSION_CREATED
,
78 P_EVENT_FW_APP_SESSION_TERMINATED
,
79 P_EVENT_FW_APP_AGREEMENT_SIGNED
,
80 P_EVENT_FW_APP_AGREEMENT_ENDED
84 enum TpFWExceptionType
{
90 typedef TpString TpFwID
;
93 enum TpFwUnavailReason
{
95 FW_UNAVAILABLE_UNDEFINED
,
96 FW_UNAVAILABLE_LOCAL_FAILURE
,
97 FW_UNAVAILABLE_GATEWAY_FAILURE
,
98 FW_UNAVAILABLE_OVERLOADED
,
99 FW_UNAVAILABLE_CLOSED
,
100 FW_UNAVAILABLE_PROTOCOL_FAILURE
104 typedef TpString TpHomePage
;
107 enum TpInterfaceFault
{
109 INTERFACE_FAULT_UNDEFINED
,
110 INTERFACE_FAULT_LOCAL_FAILURE
,
111 INTERFACE_FAULT_GATEWAY_FAILURE
,
112 INTERFACE_FAULT_PROTOCOL_ERROR
116 struct TpFaultStats
{
117 TpInterfaceFault Fault
;
120 TpInt32 TotalDuration
;
121 TpInt32 NumberOfClientsAffected
;
125 typedef sequence
<TpFaultStats
> TpFaultStatsSet
;
128 struct TpFaultStatsRecord
{
129 TpTimeInterval Period
;
130 TpFaultStatsSet FaultStatsSet
;
134 typedef TpString TpInterfaceName
;
141 LOAD_LEVEL_SEVERE_OVERLOAD
145 struct TpLoadPolicy
{
150 struct TpLoadStatisticData
{
152 TpLoadLevel LoadLevel
;
156 enum TpLoadStatisticEntityType
{
158 P_LOAD_STATISTICS_FW_TYPE
,
159 P_LOAD_STATISTICS_SVC_TYPE
,
160 P_LOAD_STATISTICS_APP_TYPE
164 enum TpLoadStatisticInfoType
{
166 P_LOAD_STATISTICS_VALID
,
167 P_LOAD_STATISTICS_INVALID
171 enum TpLoadStatusError
{
173 LOAD_STATUS_ERROR_UNDEFINED
,
174 LOAD_STATUS_ERROR_UNAVAILABLE
178 struct TpLoadThreshold
{
179 TpFloat LoadThreshold
;
183 struct TpLoadInitVal
{
184 TpLoadLevel LoadLevel
;
185 TpLoadThreshold LoadThreshold
;
189 typedef TpString TpPersonName
;
192 typedef TpString TpPostalAddress
;
195 typedef TpString TpPropertyName
;
198 typedef TpString TpPropertyValue
;
202 TpPropertyName PropertyName
;
203 TpPropertyValue PropertyValue
;
207 typedef sequence
<TpProperty
> TpPropertyList
;
210 typedef TpPropertyList TpClientAppProperties
;
213 struct TpClientAppDescription
{
214 TpClientAppID ClientAppID
;
215 TpClientAppProperties ClientAppProperties
;
216 TpBoolean HasAccessSession
;
217 TpBoolean HasServiceInstances
;
221 typedef TpPropertyList TpEndAccessProperties
;
224 typedef TpPropertyList TpEntOpProperties
;
229 TpEntOpProperties EntOpProperties
;
233 typedef TpPropertyList TpPersonProperties
;
236 typedef TpString TpSagDescription
;
239 typedef TpString TpSagID
;
244 TpSagDescription SagDescription
;
248 typedef sequence
<TpSagID
> TpSagIDList
;
251 typedef TpString TpServiceContractID
;
254 typedef TpDateAndTime TpServiceEndDate
;
257 typedef TpString TpServiceID
;
260 typedef sequence
<TpServiceID
> TpServiceIDList
;
263 typedef TpString TpServiceProfileID
;
266 typedef sequence
<TpServiceProfileID
> TpServiceProfileIDList
;
269 enum TpServiceTypePropertyMode
{
278 typedef TpString TpServicePropertyName
;
281 typedef sequence
<TpServicePropertyName
> TpServicePropertyNameList
;
284 typedef TpString TpServicePropertyTypeName
;
287 typedef TpString TpServicePropertyValue
;
290 typedef sequence
<TpServicePropertyValue
> TpServicePropertyValueList
;
293 struct TpServiceProperty
{
294 TpServicePropertyName ServicePropertyName
;
295 TpServicePropertyValueList ServicePropertyValueList
;
299 typedef sequence
<TpServiceProperty
> TpServicePropertyList
;
302 typedef TpDateAndTime TpServiceStartDate
;
305 typedef TpServicePropertyList TpServiceSubscriptionProperties
;
308 typedef TpString TpServiceSupplierID
;
311 typedef TpString TpServiceToken
;
314 typedef TpString TpServiceTypeName
;
317 struct TpServiceDescription
{
318 TpServiceTypeName ServiceTypeName
;
319 TpServicePropertyList ServicePropertyList
;
324 TpServiceID ServiceID
;
325 TpServiceDescription ServiceDescription
;
329 typedef sequence
<TpService
> TpServiceList
;
332 struct TpServiceProfileDescription
{
333 TpServiceContractID ServiceContractID
;
334 TpServiceStartDate ServiceStartDate
;
335 TpServiceEndDate ServiceEndDate
;
336 TpServiceTypeName ServiceTypeName
;
337 TpServiceSubscriptionProperties ServiceSubscriptionProperties
;
339 TpServiceID ServiceID
;
343 typedef sequence
<TpServiceTypeName
> TpServiceTypeNameList
;
346 union TpFwEventCriteria
switch(TpFwEventName
) {
347 case P_EVENT_FW_NAME_UNDEFINED
: TpString EventNameUndefined
;
348 case P_EVENT_FW_SERVICE_AVAILABLE
: TpServiceTypeNameList ServiceTypeNameList
;
349 case P_EVENT_FW_SERVICE_UNAVAILABLE
: TpServiceTypeNameList UnavailableServiceTypeNameList
;
350 case P_EVENT_FW_MIGRATION_SERVICE_AVAILABLE
: TpServiceTypeNameList CompatibleServiceTypeNameList
;
351 case P_EVENT_FW_APP_SESSION_CREATED
: TpClientAppIDList SessionCreatedList
;
352 case P_EVENT_FW_APP_SESSION_TERMINATED
: TpClientAppIDList SessionTerminatedList
;
353 case P_EVENT_FW_APP_AGREEMENT_SIGNED
: TpClientAppIDList AgreementSignedList
;
354 case P_EVENT_FW_APP_AGREEMENT_ENDED
: TpClientAppIDList AgreementEndedList
;
358 struct TpServiceTypeProperty
{
359 TpServicePropertyName ServicePropertyName
;
360 TpServiceTypePropertyMode ServiceTypePropertyMode
;
361 TpServicePropertyTypeName ServicePropertyTypeName
;
365 typedef sequence
<TpServiceTypeProperty
> TpServiceTypePropertyList
;
368 struct TpServiceTypeDescription
{
369 TpServiceTypePropertyList ServiceTypePropertyList
;
370 TpServiceTypeNameList ServiceTypeNameList
;
371 TpBoolean AvailableOrUnavailable
;
375 struct TpSignatureAndServiceMgr
{
376 TpOctetSet DigitalSignature
;
377 IpService ServiceMgrInterface
;
381 typedef TpString TpSigningAlgorithm
;
384 enum TpSvcUnavailReason
{
386 SERVICE_UNAVAILABLE_UNDEFINED
,
387 SERVICE_UNAVAILABLE_LOCAL_FAILURE
,
388 SERVICE_UNAVAILABLE_GATEWAY_FAILURE
,
389 SERVICE_UNAVAILABLE_OVERLOADED
,
390 SERVICE_UNAVAILABLE_CLOSED
394 typedef TpString TpTelephoneNumber
;
398 TpPersonName PersonName
;
399 TpPostalAddress PostalAddress
;
400 TpTelephoneNumber TelephoneNumber
;
403 TpPersonProperties PersonProperties
;
407 typedef TpPerson TpBillingContact
;
410 typedef TpPerson TpServiceRequestor
;
413 struct TpServiceContractDescription
{
414 TpServiceRequestor ServiceRequestor
;
415 TpBillingContact BillingContact
;
416 TpServiceStartDate ServiceStartDate
;
417 TpServiceEndDate ServiceEndDate
;
418 TpServiceTypeName ServiceTypeName
;
419 TpServiceID ServiceID
;
420 TpServiceSubscriptionProperties ServiceSubscriptionProperties
;
425 union TpLoadStatisticEntityID
switch(TpLoadStatisticEntityType
) {
426 case P_LOAD_STATISTICS_FW_TYPE
: TpFwID FrameworkID
;
427 case P_LOAD_STATISTICS_SVC_TYPE
: TpServiceID ServiceID
;
428 case P_LOAD_STATISTICS_APP_TYPE
: TpClientAppID ClientAppID
;
432 enum TpLoadStatisticError
{
434 P_LOAD_INFO_ERROR_UNDEFINED
,
435 P_LOAD_INFO_UNAVAILABLE
438 typedef sequence
<TpLoadStatisticError
> TpLoadStatisticErrorList
;
441 union TpLoadStatisticInfo
switch(TpLoadStatisticInfoType
) {
442 case P_LOAD_STATISTICS_VALID
: TpLoadStatisticData LoadStatisticData
;
443 case P_LOAD_STATISTICS_INVALID
: TpLoadStatisticError LoadStatisticError
;
447 struct TpLoadStatistic
{
448 TpLoadStatisticEntityID LoadStatisticEntityID
;
449 TpDateAndTime TimeStamp
;
450 TpLoadStatisticInfo LoadStatisticInfo
;
454 typedef sequence
<TpLoadStatistic
> TpLoadStatisticList
;
457 exception P_INVALID_SERVICE_ID
{
458 TpString ExtraInformation
;
462 exception P_SERVICE_ACCESS_DENIED
{
463 TpString ExtraInformation
;
467 exception P_ACCESS_DENIED
{
468 TpString ExtraInformation
;
472 exception P_SERVICE_NOT_ENABLED
{
473 TpString ExtraInformation
;
477 exception P_INVALID_ENCRYPTION_CAPABILITY
{
478 TpString ExtraInformation
;
482 exception P_NO_ACCEPTABLE_ENCRYPTION_CAPABILITY
{
483 TpString ExtraInformation
;
487 exception P_INVALID_AGREEMENT_TEXT
{
488 TpString ExtraInformation
;
492 exception P_INVALID_SERVICE_TOKEN
{
493 TpString ExtraInformation
;
497 exception P_INVALID_SIGNATURE
{
498 TpString ExtraInformation
;
502 exception P_INVALID_SIGNING_ALGORITHM
{
503 TpString ExtraInformation
;
507 exception P_INVALID_DOMAIN_ID
{
508 TpString ExtraInformation
;
512 exception P_INVALID_PROPERTY
{
513 TpString ExtraInformation
;
517 struct TpServiceContract
{
518 TpServiceContractID ServiceContractID
;
519 TpServiceContractDescription ServiceContractDescription
;
523 struct TpServiceProfile
{
524 TpServiceProfileID ServiceProfileID
;
525 TpServiceProfileDescription ServiceProfileDescription
;
529 exception P_INVALID_ACCESS_TYPE
{
530 TpString ExtraInformation
;
534 exception P_ILLEGAL_SERVICE_TYPE
{
535 TpString ExtraInformation
;
539 exception P_UNKNOWN_SERVICE_TYPE
{
540 TpString ExtraInformation
;
544 exception P_MISSING_MANDATORY_PROPERTY
{
545 TpString ExtraInformation
;
549 exception P_DUPLICATE_PROPERTY_NAME
{
550 TpString ExtraInformation
;
554 exception P_PROPERTY_TYPE_MISMATCH
{
555 TpString ExtraInformation
;
559 exception P_INVALID_SERVICE_TYPE
{
560 TpString ExtraInformation
;
564 exception P_INVALID_CLIENT_APP_ID
{
565 TpString ExtraInformation
;
569 exception P_INVALID_AUTH_TYPE
{
570 TpString ExtraInformation
;
574 exception P_INVALID_SAG_ID
{
575 TpString ExtraInformation
;
579 exception P_INVALID_SERVICE_PROFILE_ID
{
580 TpString ExtraInformation
;
584 exception P_INVALID_SERVICE_CONTRACT_ID
{
585 TpString ExtraInformation
;
589 exception P_INVALID_ACTIVITY_TEST_ID
{
590 TpString ExtraInformation
;
594 exception P_INVALID_ENT_OP_ID
{
595 TpString ExtraInformation
;
599 exception P_ILLEGAL_SERVICE_ID
{
600 TpString ExtraInformation
;
604 exception P_UNKNOWN_SERVICE_ID
{
605 TpString ExtraInformation
;
609 typedef sequence
<TpInterfaceName
> TpInterfaceNameList
;
615 P_SUBJECT_CLIENT_APP
,
620 enum TpFaultStatisticsError
{
622 P_FAULT_INFO_ERROR_UNDEFINED
,
623 P_FAULT_INFO_UNAVAILABLE
627 typedef TpString TpServiceInstanceID
;
630 union TpDomainID
switch(TpDomainIDType
) {
631 case P_FW
: TpFwID FwID
;
632 case P_CLIENT_APPLICATION
: TpClientAppID ClientAppID
;
633 case P_ENT_OP
: TpEntOpID EntOpID
;
634 case P_SERVICE_INSTANCE
: TpServiceInstanceID ServiceID
;
635 case P_SERVICE_SUPPLIER
: TpServiceSupplierID ServiceSupplierID
;
639 struct TpAuthDomain
{
641 IpInterface AuthInterface
;
645 typedef sequence
<TpServiceContractID
> TpServiceContractIDList
;
648 exception P_SERVICE_TYPE_UNAVAILABLE
{
649 TpString ExtraInformation
;
653 struct TpSagProfilePair
{
655 TpServiceProfileID ServiceProfile
;
659 struct TpAddSagMembersConflict
{
660 TpClientAppID ClientApplication
;
661 TpSagProfilePair ConflictGeneratingSagProfilePair
;
662 TpSagProfilePair AlreadyAssignedSagProfilePair
;
667 typedef sequence
<TpAddSagMembersConflict
> TpAddSagMembersConflictList
;
670 struct TpAssignSagToServiceProfileConflict
{
671 TpClientAppID ClientApplication
;
672 TpSagProfilePair AlreadyAssignedSagProfilePair
;
677 typedef sequence
<TpAssignSagToServiceProfileConflict
> TpAssignSagToServiceProfileConflictList
;
680 exception P_INVALID_ADDITION_TO_SAG
{
681 TpString ExtraInformation
;
685 exception P_INVALID_SAG_TO_SERVICE_PROFILE_ASSIGNMENT
{
686 TpString ExtraInformation
;
690 typedef TpString TpAuthMechanism
;
693 typedef TpString TpAuthMechanismList
;
696 typedef TpString TpSigningAlgorithmCapabilityList
;
699 exception P_NO_ACCEPTABLE_AUTHENTICATION_MECHANISM
{
700 TpString ExtraInformation
;
704 exception P_NO_ACCEPTABLE_SIGNING_ALGORITHM
{
705 TpString ExtraInformation
;
709 enum TpSvcAvailStatusReason
{
711 SVC_UNAVAILABLE_UNDEFINED
,
712 SVC_UNAVAILABLE_LOCAL_FAILURE
,
713 SVC_UNAVAILABLE_GATEWAY_FAILURE
,
714 SVC_UNAVAILABLE_OVERLOADED
,
715 SVC_UNAVAILABLE_CLOSED
,
716 SVC_UNAVAILABLE_NO_RESPONSE
,
717 SVC_UNAVAILABLE_SW_UPGRADE
,
722 enum TpAppAvailStatusReason
{
724 APP_UNAVAILABLE_UNDEFINED
,
725 APP_UNAVAILABLE_LOCAL_FAILURE
,
726 APP_UNAVAILABLE_REMOTE_FAILURE
,
727 APP_UNAVAILABLE_OVERLOADED
,
728 APP_UNAVAILABLE_CLOSED
,
729 APP_UNAVAILABLE_NO_RESPONSE
,
730 APP_UNAVAILABLE_SW_UPGRADE
,
735 typedef TpInt32 TpLoadTestID
;
738 typedef sequence
<TpFaultStatisticsError
> TpFaultStatsErrorList
;
741 typedef TpInt32 TpFaultReqID
;
744 struct TpServiceTypePropertyValue
{
745 TpServicePropertyName ServicePropertyName
;
746 TpServiceTypePropertyMode ServiceTypePropertyMode
;
747 TpServicePropertyTypeName ServicePropertyTypeName
;
748 TpServicePropertyValueList ServicePropertyValueList
;
752 typedef sequence
<TpServiceTypePropertyValue
> TpServiceTypePropertyValueList
;
755 enum TpMigrationAdditionalInfoType
{
757 P_MIGRATION_INFO_UNDEFINED
761 union TpMigrationAdditionalInfo
switch(TpMigrationAdditionalInfoType
) {
762 default: short Dummy
;
766 typedef sequence
<TpMigrationAdditionalInfo
> TpMigrationAdditionalInfoSet
;
769 struct TpFwMigrationServiceAvailableInfo
{
770 TpServiceTypeName ServiceType
;
771 TpServiceID ServiceID
;
772 TpServiceID CompatibleServiceID
;
773 TpBoolean BackwardCompatibilityLevel
;
774 TpBoolean MigrationRequired
;
775 TpBoolean DataMigrated
;
776 TpDateAndTime MigrationDataAndTime
;
777 TpMigrationAdditionalInfoSet MigrationAdditionalInfo
;
781 enum TpFwAvailStatusReason
{
783 FRAMEWORK_UNAVAILABLE_UNDEFINED
,
784 FRAMEWORK_UNAVAILABLE_LOCAL_FAILURE
,
785 FRAMEWORK_UNAVAILABLE_REMOTE_FAILURE
,
786 FRAMEWORK_UNAVAILABLE_OVERLOADED
,
787 FRAMEWORK_UNAVAILABLE_CLOSED
,
788 FRAMEWORK_UNAVAILABLE_PROTOCOL_FAILURE
,
789 FRAMEWORK_UNAVAILABLE_SW_UPGRADE
,
794 struct TpFwAgreementInfo
{
795 TpClientAppID ClientApplicationID
;
796 TpServiceID ServiceID
;
797 TpServiceContractID ServiceContractID
;
798 TpServiceProfileID ServiceProfileID
;
802 union TpFwEventInfo
switch(TpFwEventName
) {
803 case P_EVENT_FW_NAME_UNDEFINED
: TpString EventNameUndefined
;
804 case P_EVENT_FW_SERVICE_AVAILABLE
: TpServiceIDList ServiceIDList
;
805 case P_EVENT_FW_SERVICE_UNAVAILABLE
: TpServiceIDList UnavailableServiceIDList
;
806 case P_EVENT_FW_MIGRATION_SERVICE_AVAILABLE
: TpFwMigrationServiceAvailableInfo MigrationServiceAvailable
;
807 case P_EVENT_FW_APP_SESSION_CREATED
: TpClientAppID AppSessionCreated
;
808 case P_EVENT_FW_APP_SESSION_TERMINATED
: TpClientAppID AppSessionTerminated
;
809 case P_EVENT_FW_APP_AGREEMENT_SIGNED
: TpFwAgreementInfo AppAgreementSigned
;
810 case P_EVENT_FW_APP_AGREEMENT_ENDED
: TpFwAgreementInfo AppAgreementEnded
;