This document describes the protocol compliance and protocol convenience APIs of CGIN 2.0.0.

Topics

Protocol Compliance

How various protocols comply with this version of CGIN.

Convenience APIs

APIs for encoding and decoding of information into and out of byte arrays.

Other documentation for CGIN can be found on the CGIN product page.

Protocol Compliance

The following protocols are compatible with this release of CGIN.

Warning Each protocol’s coverage is limited to behavior specified at the network level — encoding of messages, mapping to TCAP, and so on. Other application-level behavioral requirements, such as management of call state machines, are the responsibility of the implementing SLEE service.
Protocol Full name ASN.1 version Notes

CallControl

Call control pseudo-protocol

OC CGIN 2.0.0

A pseudo-protocol — not a real network protocol — that offers the common features of CAP, INAP, and vendor-specific variants. The classes in its API are ancestors of those of real protocols; they allow development of general services, plus protocol-specific special cases as necessary.

CAP-v1

CAMEL Application Part, Phase 2+ (CAP-v1)

GSM v09.78 / ETSI TS 101 046 5.7.0 Release 1996

For dependencies on 3GPP TS 29.002 (MAP), modules with version 12 from release 10 are used.

CAP-v2

CAMEL Application Part, Phase 2+ (CAP-v2)

GSM v09.78 / ETSI TS 101 046 7.1.0 Release 1998

For dependencies on 3GPP TS 29.002 (MAP), modules with version 12 from release 10 are used.

CAP-v3

CAMEL Application Part, Phase 3 (CAP-v3)

3GPP TS 29.078 v4.8.0 Release 4

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).

CAP-v4

CAMEL Application Part (CAP) v.4

3GPP TS 29.078 V9.1.1 Release 9

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).

INAP

ETSI-INAP-CS1

ETS 300 374-1 dated 1994-09

This is the "standard" INAP, of which there are many proprietary variations (see below).

MAP

3GPP Mobile Application Part (MAP), Release 10

3GPP TS 29.002 V10.0.0 (2010-09)

This API and underlying implementation supports not only the latest version of the application contexts, as defined directly in Release 10, but also the operations and errors of all earlier versions of those application contexts.

ECS1

Ericsson INAP CS1

2/155 17-CRT 249 10 Uen: 1998-10-09 Rev D

Please contact OpenCloud for further information regarding the support of this protocol.

ECS1+

Ericsson INAP CS1+

171/155 17-CRT 249 12 Uen: 2003-06-30 Rev B

Please contact OpenCloud for further information regarding the support of this protocol.

SINAP5m+

Siemens INAP 5m+

P30308-A8824-A017-03-7665

Please contact OpenCloud for further information regarding the support of this protocol.

SINAP7m+

Siemens INAP 7m+

P30308-A8824-A030-09-7662

Please contact OpenCloud for further information regarding the support of this protocol.

NINAP

Nokia INAP CS1

DN00212979 Issue 6-0

Please contact OpenCloud for further information regarding the support of this protocol.

TPINAP7

TP INAP 7

TP-INAP7v7-2.doc

Please contact OpenCloud for further information regarding the support of this protocol.

INAP1SK

INAP1 SK

INAP-SK_1_ed4.pdf, INAP1-SK_2_ed3.pdf

Please contact OpenCloud for further information regarding the support of this protocol.

XS0004

X.S0004

X.S0004-E

Please contact OpenCloud for further information regarding the support of this protocol.

Convenience APIs

To encode and decode…​

Where a protocol’s ASN.1 specification uses OCTET STRING with no CONTAINING clause, the auto-generated API uses byte[]. CGIN provides additional convenience APIs for some such types, to ease the encoding and decoding of information into and out of the byte arrays. The following tables associate the names of some ASN.1 OCTET STRING types with the convenience APIs that are provided for them in package com.opencloud.slee.resources.in.datatypes. Access to the byte arrays underlying these convenience APIs is provided.

Below are APIs for:

CallControl

CallControl Convenience API

AdditionalCallingPartyNumber

cc.GenericNumber

AlertingPattern

cc.Signal

AssistingSSPIPRoutingAddress

cc.GenericNumber

AssistRequestInstructionsArg.correlationID

cc.GenericNumber

BasicGapCriteria.calledAddressAndService.​calledAddressValue

cc.GenericNumber

BasicGapCriteria.calledAddressValue

cc.GenericNumber

BasicGapCriteria.callingAddressAndService.​callingAddressValue

cc.GenericNumber

BearerCapability.bearerCap

cc.BearerCapability

CalledPartyNumber

cc.CalledPartyNumber

CallingPartyNumber

cc.CallingPartyNumber

CallingPartysCategory

cc.CallingPartysCategory

Cause

cc.Cause

CollectedDigits.cancelDigit

cc.AddressDelimiter

CollectedDigits.endOfReplyDigit

cc.AddressDelimiter

CollectedDigits.startDigit

cc.AddressDelimiter

DateAndTime

cc.DateAndTime

EstablishTemporaryConnectionArg.correlationID

cc.GenericDigits

HighLayerCompatibility

cc.HighLayerCompatibility

LegType

cc.LegType

LocationNumber

cc.LocationNumber

OriginalCalledPartyID

cc.OriginalCalledNumber

ReceivedInformationArg.digitsResponse

cc.GenericDigits

RedirectingPartyID

cc.RedirectingPartyNumber

RedirectionInformation

cc.RedirectionInformation

VariablePart.date

cc.YearMonthDay

VariablePart.number

cc.GenericDigits

VariablePart.price

cc.PriceInHundredthsOfUnits

VariablePart.time

cc.HourMinute

ETSI-INAP-CS1

ETSI-INAP-CS1 Convenience API

AdditionalCallingPartyNumber

cc.GenericNumber

AlertingPattern

cc.Signal

AssistingSSPIPRoutingAddress

cc.GenericNumber

AssistRequestInstructionsArg.correlationID

cc.GenericNumber

BasicGapCriteria.calledAddressAndService.​calledAddressValue

cc.GenericNumber

BasicGapCriteria.calledAddressValue

cc.GenericNumber

BasicGapCriteria.callingAddressAndService.​callingAddressValue

cc.GenericNumber

BearerCapability.bearerCap

cc.BearerCapability

CalledPartyNumber

cc.CalledPartyNumber

CallingPartyNumber

cc.CallingPartyNumber

CallingPartysCategory

cc.CallingPartysCategory

Cause

cc.Cause

CollectedDigits.cancelDigit

cc.AddressDelimiter

CollectedDigits.endOfReplyDigit

cc.AddressDelimiter

CollectedDigits.startDigit

cc.AddressDelimiter

ConnectArg.correlationID

cc.GenericDigits

DateAndTime

cc.DateAndTime

EstablishTemporaryConnectionArg.correlationID

cc.GenericDigits

FilteringCriteria.addressAndService.​calledAddressValue

cc.GenericNumber

FilteringCriteria.addressAndService.​callingAddressValue

cc.GenericNumber

ForwardCallIndicators

cc.ForwardCallIndicators

HighLayerCompatibility

cc.HighLayerCompatibility

LegType

cc.LegType

LocationNumber

cc.LocationNumber

OriginalCalledPartyID

cc.OriginalCalledNumber

ReceivedInformationArg.digitsResponse

cc.GenericDigits

RedirectingPartyID

cc.RedirectingPartyNumber

RedirectionInformation

cc.RedirectionInformation

RequestedInformationValue.​calledAddressValue

cc.GenericNumber

VariablePart.date

cc.YearMonthDay

VariablePart.number

cc.GenericDigits

VariablePart.price

cc.PriceInHundredthsOfUnits

VariablePart.time

cc.HourMinute

CAP-v1

CAP-v1 Convenience API

AdditionalCallingPartyNumber

cc.GenericNumber

BearerCapability.bearerCap

cc.BearerCapability

CalledPartyBCDNumber

cc.CalledPartyBCDNumber

CalledPartyNumber

cc.CalledPartyNumber

CallingPartyNumber

cc.CallingPartyNumber

Cause

cc.Cause

GenericNumber

cc.GenericNumber

LegType

cc.LegType

LocationNumber

cc.LocationNumber

OriginalCalledPartyID

cc.OriginalCalledNumber

RedirectingPartyID

cc.RedirectingPartyNumber

CAP-v2

CAP-v2 Convenience API

AdditionalCallingPartyNumber

cc.GenericNumber

AlertingPattern

cc.Signal

AssistingSSPIPRoutingAddress

cc.GenericNumber

AssistRequestInstructionsArg.correlationID

cc.GenericNumber

BearerCapability.bearerCap

cc.BearerCapability

CalledPartyBCDNumber

cc.CalledPartyBCDNumber

CalledPartyNumber

cc.CalledPartyNumber

CallingPartyNumber

cc.CallingPartyNumber

CAPIPSSPCapabilities

cc.CAPIPSSPCapabilities

Cause

cc.Cause

CollectedDigits.cancelDigit

cc.AddressDelimiter

CollectedDigits.endOfReplyDigit

cc.AddressDelimiter

CollectedDigits.startDigit

cc.AddressDelimiter

DateAndTime

cc.DateAndTime

EstablishTemporaryConnectionArg.correlationID

cc.GenericDigits

GenericNumber

cc.GenericNumber

LegType

cc.LegType

LocationNumber

cc.LocationNumber

OriginalCalledPartyID

cc.OriginalCalledNumber

ReceivedInformationArg.digitsResponse

cc.GenericDigits

RedirectingPartyID

cc.RedirectingPartyNumber

TimeAndTimezone

cc.TimeAndTimezone

VariablePart.date

cc.YearMonthDay

VariablePart.number

cc.GenericDigits

VariablePart.price

cc.PriceInHundredthsOfUnits

VariablePart.time

cc.HourMinute

CAP-v3

CAP-v3 Convenience API

AccessPointName

cc.AccessPointName

AdditionalCallingPartyNumber

cc.GenericNumber

AlertingPattern

cc.Signal

AssistingSSPIPRoutingAddress

cc.GenericNumber

AssistRequestInstructionsArg.correlationID

cc.GenericNumber

BackwardServiceInteractionInd.​callCompletionTreatmentIndicator

cc.Treatment

BackwardServiceInteractionInd.​conferenceTreatmentIndicator

cc.Treatment

BasicGapCriteria.calledAddressAndService.​calledAddressValue

cc.GenericNumber

BasicGapCriteria.calledAddressValue

cc.GenericNumber

BasicGapCriteria.callingAddressAndService.​callingAddressValue

cc.GenericNumber

BearerCapability.bearerCap

cc.BearerCapability

CalledPartyBCDNumber

cc.CalledPartyBCDNumber

CalledPartyNumber

cc.CalledPartyNumber

CallingPartyNumber

cc.CallingPartyNumber

CAPIPSSPCapabilities

cc.CAPIPSSPCapabilities

Cause

cc.Cause

CollectedDigits.cancelDigit

cc.AddressDelimiter

CollectedDigits.endOfReplyDigit

cc.AddressDelimiter

CollectedDigits.startDigit

cc.AddressDelimiter

DateAndTime

cc.DateAndTime

EstablishTemporaryConnectionArg.correlationID

cc.GenericDigits

ForwardServiceInteractionInd.​callDiversionTreatmentIndicator

cc.Treatment

ForwardServiceInteractionInd.​callingPartyRestrictionIndicator

cc.CallingPartyRestriction

ForwardServiceInteractionInd.​conferenceTreatmentIndicator

cc.Treatment

GenericNumber

cc.GenericNumber

LegType

cc.LegType

LocationNumber

cc.LocationNumber

OriginalCalledPartyID

cc.OriginalCalledNumber

ReceivedInformationArg.digitsResponse

cc.GenericDigits

RedirectingPartyID

cc.RedirectingPartyNumber

RPCause

sms.RPCause

ServiceInteractionIndicatorsTwo.​cwTreatmentIndicator

cc.Treatment

ServiceInteractionIndicatorsTwo.​ectTreatmentIndicator

cc.Treatment

ServiceInteractionIndicatorsTwo.​holdTreatmentIndicator

cc.Treatment

TimeAndTimezone

cc.TimeAndTimezone

TPProtocolIdentifier

sms.SMSProtocolId

VariablePart.date

cc.YearMonthDay

VariablePart.number

cc.GenericDigits

VariablePart.price

cc.PriceInHundredthsOfUnits

VariablePart.time

cc.HourMinute

CAP-v4

CAP-v4 Convenience API

AccessPointName

cc.AccessPointName

AdditionalCallingPartyNumber

cc.GenericNumber

AddressString

cc.AddressString

AlertingPattern

cc.Signal

AssistingSSPIPRoutingAddress

cc.GenericNumber

AssistingSSPIPRoutingAddress

cc.GenericNumber

AssistRequestInstructionsArg.correlationID

cc.GenericNumber

BackwardServiceInteractionInd.​callCompletionTreatmentIndicator

cc.Treatment

BackwardServiceInteractionInd.​conferenceTreatmentIndicator

cc.Treatment

BasicGapCriteria.calledAddressAndService.​calledAddressValue

cc.GenericNumber

BasicGapCriteria.calledAddressValue

cc.GenericNumber

BasicGapCriteria.callingAddressAndService.​callingAddressValue

cc.GenericNumber

BearerCapability.bearerCap

cc.BearerCapability

CalledPartyBCDNumber

cc.CalledPartyBCDNumber

CalledPartyNumber

cc.CalledPartyNumber

CallingPartyNumber

cc.CallingPartyNumber

Cause

cc.Cause

CellGlobalIdOrServiceAreaIdFixedLength

cc.CellGlobalId

CollectedDigits.cancelDigit

cc.AddressDelimiter

CollectedDigits.endOfReplyDigit

cc.AddressDelimiter

CollectedDigits.startDigit

cc.AddressDelimiter

CUG-Interlock

cc.CUGInterLockCode

DateAndTime

cc.DateAndTime

EstablishTemporaryConnectionArg.correlationID

cc.GenericDigits

ForwardServiceInteractionInd.​callDiversionTreatmentIndicator

cc.Treatment

ForwardServiceInteractionInd.​callingPartyRestrictionIndicator

cc.CallingPartyRestriction

ForwardServiceInteractionInd.​conferenceTreatmentIndicator

cc.Treatment

GenericNumber

cc.GenericNumber

IMSI

cc.IMSIAddress

LAIFixedLength

cc.LocationAreaId

LegType

cc.LegType

LocationNumber

cc.LocationNumber

LocationNumber

cc.LocationNumber

LSAIdentity

cc.LocalisedServiceAreaId

OriginalCalledPartyID

cc.OriginalCalledNumber

ReceivedInformationArg.digitsResponse

cc.GenericDigits

RedirectingPartyID

cc.RedirectingPartyNumber

RPCause

sms.RPCause

ServiceInteractionIndicatorsTwo.​cwTreatmentIndicator

cc.Treatment

ServiceInteractionIndicatorsTwo.​ectTreatmentIndicator

cc.Treatment

ServiceInteractionIndicatorsTwo.​holdTreatmentIndicator

cc.Treatment

TimeAndTimezone

cc.TimeAndTimezone

TPProtocolIdentifier

sms.SMSProtocolId

VariablePart.date

cc.YearMonthDay

VariablePart.number

cc.GenericDigits

VariablePart.price

cc.PriceInHundredthsOfUnits

VariablePart.time

cc.HourMinute

MAP

This API and underlying implementation is based on MAP Release 10: 3GPP TS 29.002 V10.0.0 (2010-09).

It supports not only the latest version of the application contexts, as defined directly in Release 10, but also the operations and errors of earlier versions of those application contexts, back as far as the MAP Phase 2 release.

The following earlier releases have been consulted to determine when each operation, each error, and each parameter thereof was added to the MAP protocol.

Release 9: 3GPP TS 29.002 V9.3.0 (2010-09)
Release 8: 3GPP TS 29.002 V8.10.0 (2009-06)
Release 7: 3GPP TS 29.002 V7.15.0 (2010-06)
Release 6: 3GPP TS 29.002 V6.17.0 (2010-06)
Release 5: 3GPP TS 29.002 V5.13.0 (2007-09)
Release 4: 3GPP TS 29.002 V4.18.0 (2007-09)
Release 99: 3GPP TS 29.002 V3.20.0 (2004-06)
Release 98: 3GPP TS 09.02 V7.15.0 (2004-03)
Release 97: 3GPP TS 09.02 V6.14.0 (2003-09)
Release 96: 3GPP TS 09.02 V5.19.0 (2003-09)
Phase 2: GSM 09.02 V4.19.1 (2000-12)
Phase 1: GSM 09.02 V3.11.0 (1995-04)

MAP Convenience API

AddressString

cc.AddressString

APN

map.AccessPointName

CallDiversionTreatmentIndicator

cc.Treatment

CellGlobalIdOrServiceAreaIdFixedLength

cc.CellGlobalId

CUG-Interlock

cc.CUGInterLockCode

Ext-ForwOptions

map.ExtForwOptions

IMEI

cc.IMEIAddress

IMSI

cc.IMSIAddress

ISDN-SubaddressString

map.ISDNSubaddress

LAIFixedLength

cc.LocationAreaId

LMSI

cc.LMSIAddress

LocationNumber

cc.LocationNumber

LSAIdentity

cc.LocalisedServiceAreaId

MM-Code

map.MMCode

MO-ForwardSM-Arg.sm-RP-UI

sms.SMSTPDU

MO-ForwardSM-Res.sm-RP-UI

sms.SMSTPDU

MT-ForwardSM-Arg.sm-RP-UI

sms.SMSTPDU

MT-ForwardSM-Res.sm-RP-UI

sms.SMSTPDU

SM-DeliveryFailureCause.diagnosticInfo

sms.SMSTPDU

SS-Code

map.SSCode