Package com.opencloud.slee.resources.cgin.cap_v1

Provides an API for the CAP v1 protocol.

Overview

This package provides a machine-generated API for CAMEL Application Part, Phase 2+ (CAP v1). It is organized as an extension of the common callcontrol protocol, with changes for CAP v1-specific protocol details.

Protocol compliance

This API and underlying implementation is based on GSM 09.78 / ETSI TS 101 046 V5.7.0 Release 1996. For its dependencies on 3GPP TS 29.002 (MAP), modules with version 12 from release 10 are used.

API packages and identifier prefix

The CAP v1 API is divided into these subpackages:

  • com.opencloud.slee.resources.cgin.cap_v1 - contains datatype classes and misc helper classes such as CAP1Dialog;
  • com.opencloud.slee.resources.cgin.cap_v1.metadata - contains metadata classes defining application contexts, operations, and errors;
  • com.opencloud.slee.resources.cgin.cap_v1.persist - provides conversion between CGIN data objects of this protocol and Google protobuf (GPB) messages.
There is no events subpackage because all events are inherited.

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

Dialog Extension Interface

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