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

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.