Package com.opencloud.slee.resources.cgin.etsi_inap_cs1

Provides an API for the ETSI INAP CS1 protocol.

See: Description

Interface Summary

Interface	Description
CS1Dialog	Protocol-specific extension interface for etsi_inap_cs1 dialogs.

Class Summary

Class	Description
CS1ActivateServiceFilteringArg	API for Core-INAP-CS1-DataTypes.ActivateServiceFilteringArg.
CS1ApplyChargingArg	API for Core-INAP-CS1-DataTypes.ApplyChargingArg.
CS1AssistRequestInstructionsArg	API for Core-INAP-CS1-DataTypes.AssistRequestInstructionsArg.
CS1BCSMEvent	API for Core-INAP-CS1-DataTypes.BCSMEvent.
CS1CallGapArg	API for Core-INAP-CS1-DataTypes.CallGapArg.
CS1CallInformationReportArg	API for Core-INAP-CS1-DataTypes.CallInformationReportArg.
CS1CallInformationRequestArg	API for Core-INAP-CS1-DataTypes.CallInformationRequestArg.
CS1CGEncountered	API for Core-INAP-CS1-DataTypes.CGEncountered.
CS1ChargingEvent	API for Core-INAP-CS1-DataTypes.ChargingEvent.
CS1CollectInformationArg	API for Core-INAP-CS1-DataTypes.CollectInformationArg.
CS1ConnectArg	API for Core-INAP-CS1-DataTypes.ConnectArg.
CS1ConnectToResourceArg	API for Core-INAP-CS1-DataTypes.ConnectToResourceArg.
CS1CounterAndValue	API for Core-INAP-CS1-DataTypes.CounterAndValue.
CS1DPSpecificCriteria	API for Core-INAP-CS1-DataTypes.DPSpecificCriteria.
CS1DPSpecificCriteria.Choice	API for Core-INAP-CS1-DataTypes.DPSpecificCriteria.Choice.
CS1EstablishTemporaryConnectionArg	API for Core-INAP-CS1-DataTypes.EstablishTemporaryConnectionArg.
CS1EventNotificationChargingArg	API for Core-INAP-CS1-DataTypes.EventNotificationChargingArg.
CS1EventReportBCSMArg	API for Core-INAP-CS1-DataTypes.EventReportBCSMArg.
CS1EventSpecificInformationCharging	API for Core-INAP-CS1-DataTypes.EventSpecificInformationCharging.
CS1EventTypeCharging	API for Core-INAP-CS1-DataTypes.EventTypeCharging.
CS1ExtensionField	API for Core-INAP-CS1-DataTypes.ExtensionField.
CS1FilteredCallTreatment	API for Core-INAP-CS1-DataTypes.FilteredCallTreatment.
CS1FilteringCharacteristics	API for Core-INAP-CS1-DataTypes.FilteringCharacteristics.
CS1FilteringCriteria	API for Core-INAP-CS1-DataTypes.FilteringCriteria.
CS1FilteringCriteria.AddressAndService	API for Core-INAP-CS1-DataTypes.FilteringCriteria.addressAndService.
CS1FilteringTimeOut	API for Core-INAP-CS1-DataTypes.FilteringTimeOut.
CS1GapIndicators	API for Core-INAP-CS1-DataTypes.GapIndicators.
CS1GapTreatment	API for Core-INAP-CS1-DataTypes.GapTreatment.
CS1GapTreatment.Both	API for Core-INAP-CS1-DataTypes.GapTreatment.both.
CS1GapTreatment.Choice	API for Core-INAP-CS1-DataTypes.GapTreatment.Choice.
CS1InformationToSend	API for Core-INAP-CS1-DataTypes.InformationToSend.
CS1InformationToSend.Choice	API for Core-INAP-CS1-DataTypes.InformationToSend.Choice.
CS1InitialDPArg	API for Core-INAP-CS1-DataTypes.InitialDPArg.
CS1InitiateCallAttemptArg	API for Core-INAP-CS1-DataTypes.InitiateCallAttemptArg.
CS1IPAvailable	API for Core-INAP-CS1-DataTypes.IPAvailable.
CS1PlayAnnouncementArg	API for Core-INAP-CS1-DataTypes.PlayAnnouncementArg.
CS1PromptAndCollectUserInformationArg	API for Core-INAP-CS1-DataTypes.PromptAndCollectUserInformationArg.
CS1RequestedInformationType	API for Core-INAP-CS1-DataTypes.RequestedInformationType.
CS1RequestedInformationValue	API for Core-INAP-CS1-DataTypes.RequestedInformationValue.
CS1RequestedInformationValue.Choice	API for Core-INAP-CS1-DataTypes.RequestedInformationValue.Choice.
CS1RequestReportBCSMEventArg	API for Core-INAP-CS1-DataTypes.RequestReportBCSMEventArg.
CS1ResetTimerArg	API for Core-INAP-CS1-DataTypes.ResetTimerArg.
CS1SendChargingInformationArg	API for Core-INAP-CS1-DataTypes.SendChargingInformationArg.
CS1ServiceFilteringResponseArg	API for Core-INAP-CS1-DataTypes.ServiceFilteringResponseArg.
CS1ServiceInteractionIndicators	API for Core-INAP-CS1-DataTypes.ServiceInteractionIndicators.
CS1SFBillingChargingCharacteristics	API for Core-INAP-CS1-DataTypes.SFBillingChargingCharacteristics.

Enum Summary

Enum	Description
CS1Criticality	API for Core-INAP-CS1-DataTypes.Criticality.
CS1FilteringCharacteristics.Choice	API for Core-INAP-CS1-DataTypes.FilteringCharacteristics.Choice.
CS1FilteringCriteria.Choice	API for Core-INAP-CS1-DataTypes.FilteringCriteria.Choice.
CS1FilteringTimeOut.Choice	API for Core-INAP-CS1-DataTypes.FilteringTimeOut.Choice.

Package com.opencloud.slee.resources.cgin.etsi_inap_cs1 Description

Provides an API for the ETSI INAP CS1 protocol.

Overview

This package provides a machine-generated API for the ETSI INAP CS1 protocol. It is organized as an extension of the "callcontrol" pseudo-protocol, with changes for CS1-specific protocol details.

Protocol compliance

This API and underlying implementation is based on the ETSI standard ETS 300 374-1 dated 1994-09 ("ETSI INAP CS1"). In general, it implements only the behavior specified at the network level - i.e. encoding of messages, mapping to TCAP, and so on. Other application-level behavioral requirements, such as management of call state machines, are assumed to be the responsibility of the implementing SLEE service.

Specification implementation notes

• 4.6 Compatibility mechanisms used for INAP: Supported.
• 5 Single/Multiple Association Control Function (SACF/MACF) rules: Supported. The behavior described in section 5.2 is the responsibility of the SLEE service, but CGIN provides the necessary primitives to implement this.
• 6 Abstract syntax of the CS1 INAP: The abstract syntax has been updated to use ASN.1:2002 syntax and information objects. The network-level encoding is unchanged.
• 7 Application entity procedures: This section is the responsibility of the SLEE service.
• 8 Error procedures: This section is the responsibility of the SLEE service.
• 9 Detailed operation procedures: This section is the responsibility of the SLEE service.
• 10 Services assumed from TCAP: Generally implemented. Some of the behavior of this section is associated with the application-level state machines, and must be implemented by the SLEE service. CGIN provides the necessary primitives to support this.

API packages and identifier prefix

The ETSI INAP CS1 API is divided into these subpackages:

• com.opencloud.slee.resources.cgin.etsi_inap_cs1 - contains datatype classes and misc helper classes such as CS1Dialog;
• com.opencloud.slee.resources.cgin.etsi_inap_cs1.metadata - contains metadata classes defining application contexts, operations, and errors;
• com.opencloud.slee.resources.cgin.etsi_inap_cs1.events - contains the wrapper SLEE event classes used for notifying services of operation invokes and results;
• com.opencloud.slee.resources.cgin.etsi_inap_cs1.persist - provides conversion between CGIN data objects of this protocol and Google protobuf (GPB) messages.

In general, all top-level classes and interfaces in these packages begin with a common prefix, CS1, so it is safe to use a wildcard package import without colliding with other protocols.

Dialog Extension Interface

This API defines CS1Dialog, an extension of the callcontrol CCDialog interface that adds convenience methods for dealing with CS1-specific operations, results, and errors. This interface is implemented only on dialogs that actually use ETSI INAP CS1 as their network protocol.