Package com.opencloud.slee.resources.cgin.cap_v4

Provides an API for the CAP v4 protocol.

See: Description

Interface Summary

Interface	Description
CAP4Dialog	Protocol-specific extension interface for cap_v4 dialogs.

Class Summary

Class	Description
CAP4AChChargingAddress	API for CAP-datatypes.AChChargingAddress.
CAP4ApplyChargingArg	API for CAP-gsmSSF-gsmSCF-ops-args.ApplyChargingArg.
CAP4AudibleIndicator	API for CAP-datatypes.AudibleIndicator.
CAP4BCSM_Failure	API for CAP-datatypes.BCSM-Failure.
CAP4BCSMEvent	API for CAP-datatypes.BCSMEvent.
CAP4Burst	API for CAP-datatypes.Burst.
CAP4BurstList	API for CAP-datatypes.BurstList.
CAP4CallSegmentFailure	API for CAP-datatypes.CallSegmentFailure.
CAP4CallSegmentToCancel	API for CAP-datatypes.CallSegmentToCancel.
CAP4CAMEL_AChBillingChargingCharacteristics	API for CAP-datatypes.CAMEL-AChBillingChargingCharacteristics.
CAP4CAMEL_AChBillingChargingCharacteristics.Choice	API for CAP-datatypes.CAMEL-AChBillingChargingCharacteristics.Choice.
CAP4CAMEL_AChBillingChargingCharacteristics.TimeDurationCharging	API for CAP-datatypes.CAMEL-AChBillingChargingCharacteristics.timeDurationCharging.
CAP4CAMEL_CallResult	API for CAP-datatypes.CAMEL-CallResult.
CAP4CAMEL_CallResult.Choice	API for CAP-datatypes.CAMEL-CallResult.Choice.
CAP4CAMEL_CallResult.TimeDurationChargingResult	API for CAP-datatypes.CAMEL-CallResult.timeDurationChargingResult.
CAP4CAMEL_FCIBillingChargingCharacteristics	API for CAP-datatypes.CAMEL-FCIBillingChargingCharacteristics.
CAP4CAMEL_FCIBillingChargingCharacteristics.Choice	API for CAP-datatypes.CAMEL-FCIBillingChargingCharacteristics.Choice.
CAP4CAMEL_SCIBillingChargingCharacteristics	API for CAP-datatypes.CAMEL-SCIBillingChargingCharacteristics.
CAP4CAMEL_SCIBillingChargingCharacteristics.Choice	API for CAP-datatypes.CAMEL-SCIBillingChargingCharacteristics.Choice.
CAP4CAMEL_SCIBillingChargingCharacteristicsAlt	API for CAP-datatypes.CAMEL-SCIBillingChargingCharacteristicsAlt.
CAP4CancelArg	API for CAP-gsmSSF-gsmSCF-ops-args.CancelArg.
CAP4CancelArg.Choice	API for CAP-gsmSSF-gsmSCF-ops-args.CancelArg.Choice.
CAP4CAP_GPRS_ReferenceNumber	API for CAP-GPRS-ReferenceNumber.CAP-GPRS-ReferenceNumber.
CAP4ChangeOfLocation	API for CAP-datatypes.ChangeOfLocation.
CAP4ChangeOfLocationAlt	API for CAP-datatypes.ChangeOfLocationAlt.
CAP4CollectInformationArg	API for CAP-gsmSSF-gsmSCF-ops-args.CollectInformationArg.
CAP4ConnectArg	API for CAP-gsmSSF-gsmSCF-ops-args.ConnectArg.
CAP4ConnectToResourceArg	API for CAP-gsmSSF-gsmSCF-ops-args.ConnectToResourceArg.
CAP4ContinueWithArgumentArg	API for CAP-gsmSSF-gsmSCF-ops-args.ContinueWithArgumentArg.
CAP4ContinueWithArgumentArgExtension	API for CAP-gsmSSF-gsmSCF-ops-args.ContinueWithArgumentArgExtension.
CAP4DisconnectForwardConnectionWithArgumentArg	API for CAP-gsmSSF-gsmSCF-ops-args.DisconnectForwardConnectionWithArgumentArg.
CAP4DisconnectLegArg	API for CAP-gsmSSF-gsmSCF-ops-args.DisconnectLegArg.
CAP4DpSpecificCriteria	API for CAP-datatypes.DpSpecificCriteria.
CAP4DpSpecificCriteria.Choice	API for CAP-datatypes.DpSpecificCriteria.Choice.
CAP4DpSpecificCriteriaAlt	API for CAP-datatypes.DpSpecificCriteriaAlt.
CAP4DpSpecificInfoAlt	API for CAP-datatypes.DpSpecificInfoAlt.
CAP4DpSpecificInfoAlt.CollectedInfoSpecificInfo	API for CAP-datatypes.DpSpecificInfoAlt.collectedInfoSpecificInfo.
CAP4DpSpecificInfoAlt.OServiceChangeSpecificInfo	API for CAP-datatypes.DpSpecificInfoAlt.oServiceChangeSpecificInfo.
CAP4DpSpecificInfoAlt.TServiceChangeSpecificInfo	API for CAP-datatypes.DpSpecificInfoAlt.tServiceChangeSpecificInfo.
CAP4EntityReleasedArg	API for CAP-gsmSSF-gsmSCF-ops-args.EntityReleasedArg.
CAP4EstablishTemporaryConnectionArg	API for CAP-gsmSSF-gsmSCF-ops-args.EstablishTemporaryConnectionArg.
CAP4EventSpecificInformationBCSM	API for CAP-datatypes.EventSpecificInformationBCSM.
CAP4EventSpecificInformationBCSM.CallAcceptedSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.callAcceptedSpecificInfo.
CAP4EventSpecificInformationBCSM.Choice	API for CAP-datatypes.EventSpecificInformationBCSM.Choice.
CAP4EventSpecificInformationBCSM.OAbandonSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.oAbandonSpecificInfo.
CAP4EventSpecificInformationBCSM.OAnswerSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.oAnswerSpecificInfo.
CAP4EventSpecificInformationBCSM.OChangeOfPositionSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.oChangeOfPositionSpecificInfo.
CAP4EventSpecificInformationBCSM.OMidCallSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.oMidCallSpecificInfo.
CAP4EventSpecificInformationBCSM.OMidCallSpecificInfo.MidCallEvents	API for CAP-datatypes.EventSpecificInformationBCSM.oMidCallSpecificInfo.midCallEvents.
CAP4EventSpecificInformationBCSM.OTermSeizedSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.oTermSeizedSpecificInfo.
CAP4EventSpecificInformationBCSM.TAnswerSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.tAnswerSpecificInfo.
CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.tBusySpecificInfo.
CAP4EventSpecificInformationBCSM.TChangeOfPositionSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.tChangeOfPositionSpecificInfo.
CAP4EventSpecificInformationBCSM.TMidCallSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.tMidCallSpecificInfo.
CAP4EventSpecificInformationBCSM.TMidCallSpecificInfo.MidCallEvents	API for CAP-datatypes.EventSpecificInformationBCSM.tMidCallSpecificInfo.midCallEvents.
CAP4EventSpecificInformationBCSM.TNoAnswerSpecificInfo	API for CAP-datatypes.EventSpecificInformationBCSM.tNoAnswerSpecificInfo.
CAP4EventSpecificInformationSMS	API for CAP-datatypes.EventSpecificInformationSMS.
CAP4EventSpecificInformationSMS.Choice	API for CAP-datatypes.EventSpecificInformationSMS.Choice.
CAP4EventSpecificInformationSMS.O_smsSubmissionSpecificInfo	API for CAP-datatypes.EventSpecificInformationSMS.o-smsSubmissionSpecificInfo.
CAP4EventSpecificInformationSMS.T_smsDeliverySpecificInfo	API for CAP-datatypes.EventSpecificInformationSMS.t-smsDeliverySpecificInfo.
CAP4EventSpecificInformationSMS.T_smsFailureSpecificInfo	API for CAP-datatypes.EventSpecificInformationSMS.t-smsFailureSpecificInfo.
CAP4EventTypeBCSM	API for CAP-datatypes.EventTypeBCSM.
CAP4EventTypeSMS	API for CAP-datatypes.EventTypeSMS.
CAP4FurnishChargingInformationArg	API for CAP-gsmSSF-gsmSCF-ops-args.FurnishChargingInformationArg.
CAP4FurnishChargingInformationArg.Choice	API for CAP-gsmSSF-gsmSCF-ops-args.FurnishChargingInformationArg.Choice.
CAP4InitialDPArg	API for CAP-gsmSSF-gsmSCF-ops-args.InitialDPArg.
CAP4InitialDPArgExtension	API for CAP-gsmSSF-gsmSCF-ops-args.InitialDPArgExtension.
CAP4InitialDPSMSArg	API for CAP-SMS-ops-args.InitialDPSMSArg.
CAP4InitiateCallAttemptArg	API for CAP-gsmSSF-gsmSCF-ops-args.InitiateCallAttemptArg.
CAP4InitiateCallAttemptRes	API for CAP-gsmSSF-gsmSCF-ops-args.InitiateCallAttemptRes.
CAP4LegOrCallSegment	API for CAP-datatypes.LegOrCallSegment.
CAP4LocationInformationGPRS	API for CAP-datatypes.LocationInformationGPRS.
CAP4MetDPCriterion	API for CAP-datatypes.MetDPCriterion.
CAP4MetDPCriterionAlt	API for CAP-datatypes.MetDPCriterionAlt.
CAP4MidCallControlInfo	API for CAP-datatypes.MidCallControlInfo.
CAP4MoveLegArg	API for CAP-gsmSSF-gsmSCF-ops-args.MoveLegArg.
CAP4PlayAnnouncementArg	API for CAP-gsmSCF-gsmSRF-ops-args.PlayAnnouncementArg.
CAP4PlayToneArg	API for CAP-gsmSSF-gsmSCF-ops-args.PlayToneArg.
CAP4PromptAndCollectUserInformationArg	API for CAP-gsmSCF-gsmSRF-ops-args.PromptAndCollectUserInformationArg.
CAP4ResetTimerArg	API for CAP-gsmSSF-gsmSCF-ops-args.ResetTimerArg.
CAP4SendChargingInformationArg	API for CAP-gsmSSF-gsmSCF-ops-args.SendChargingInformationArg.
CAP4SplitLegArg	API for CAP-gsmSSF-gsmSCF-ops-args.SplitLegArg.

Enum Summary

Enum	Description
CAP4AChChargingAddress.Choice	API for CAP-datatypes.AChChargingAddress.Choice.
CAP4AudibleIndicator.Choice	API for CAP-datatypes.AudibleIndicator.Choice.
CAP4CAP_U_ABORT_REASON	API for CAP-U-ABORT-Data.CAP-U-ABORT-REASON.
CAP4ChangeOfLocation.Choice	API for CAP-datatypes.ChangeOfLocation.Choice.
CAP4EntityReleasedArg.Choice	API for CAP-gsmSSF-gsmSCF-ops-args.EntityReleasedArg.Choice.
CAP4EventSpecificInformationBCSM.OMidCallSpecificInfo.MidCallEvents.Choice	API for CAP-datatypes.EventSpecificInformationBCSM.oMidCallSpecificInfo.midCallEvents.Choice.
CAP4EventSpecificInformationBCSM.TMidCallSpecificInfo.MidCallEvents.Choice	API for CAP-datatypes.EventSpecificInformationBCSM.tMidCallSpecificInfo.midCallEvents.Choice.
CAP4InitiatorOfServiceChange	API for CAP-datatypes.InitiatorOfServiceChange.
CAP4LegOrCallSegment.Choice	API for CAP-datatypes.LegOrCallSegment.Choice.
CAP4MetDPCriterion.Choice	API for CAP-datatypes.MetDPCriterion.Choice.
CAP4NatureOfServiceChange	API for CAP-datatypes.NatureOfServiceChange.

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

Provides an API for the CAP v4 protocol.

Overview

This package provides a machine-generated API for CAMEL Application Part, Phase 4 (CAP v4). It is organized as an extension of the CAP v3 protocol, with changes for CAP v4-specific protocol details.

Protocol compliance

This API and underlying implementation is based on the 3GPP standard 3GPP TS 29.078 v9.1.1, which is from release 9 of CAP. For dependencies on 3GPP TS 29.002 (MAP), modules with version 12 from release 10 are used. 29.078 also depends on types from ETSI EN 301 140-1 (INAP CS-2).

Specification implementation notes

• 4.1.4 Compatibility mechanisms used for CAP: Supported.
• 4.1.5 Definition And Usage Of LegID: Supported in the API. Use is under the control of the SLEE service.
• 4.2 SACF/MACF rules: Supported. The behavior described in section 4.2.2 is the responsibility of the SLEE service, but CGIN provides the necessary primitives to implement this.
• 5 Common CAP Types: Supported.
• 6 Circuit Switched Call Control: Supported.
• 7 MO SMS Control: Supported.
• 8 GPRS Control: Supported.
• 9 Application Entity procedures: This section is the responsibility of the SLEE service.
• 10 Error procedures: This section is the responsibility of the SLEE service.
• 11 Detailed operation procedures: This section is the responsibility of the SLEE service.
• 12.1 Services assumed from TC: 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.
• 12.2 Services assumed from SCCP: Generally implemented. The available SCCP services are determined by the TCAP stack in use by CGIN. Setting the SCCP Importance of outgoing messages is not currently supported, but setting the outgoing MTP3 priority is supported.

API packages and identifier prefix

The CAP v4 API is divided into these subpackages:

• com.opencloud.slee.resources.cgin.cap_v4 - contains datatype classes and misc helper classes such as CAP4Dialog;
• com.opencloud.slee.resources.cgin.cap_v4.metadata - contains metadata classes defining application contexts, operations, and errors;
• com.opencloud.slee.resources.cgin.cap_v4.events - contains the wrapper SLEE event classes used for notifying services of operation invokes and results;
• com.opencloud.slee.resources.cgin.cap_v4.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, CAP4, so it is safe to use a wildcard package import without colliding with other protocols.

Dialog Extension Interface

This API defines CAP4Dialog, an extension of the CAP v3 CAP3Dialog interface that adds convenience methods for dealing with CAP4-specific operations, results, and errors. This interface is implemented only on dialogs that actually use CAP v4 as their network protocol.