|
TECHNICAL SPECIFICATION
Universal Mobile Telecommunications System (UMTS);
LTE;
Contact Manager Application Programming Interface (API);
Contact Manager API for Java Card
(3GPP TS 31.221 version 15.0.0 Release 15)
---------------------- Page: 1 ----------------------
3GPP TS 31.221 version 15.0.0 Release 15 1 ETSI TS 131 221 V15.0.0 (2018-07)
Reference
RTS/TSGC-0631221vf00
Keywords
LTE,UMTS
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
The present document can be downloaded from:
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the
print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
If you find errors in the present document, please send your comment to one of the following services:
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2018.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
3GPP and LTE are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M logo is protected for the benefit of its Members.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3GPP TS 31.221 version 15.0.0 Release 15 2 ETSI TS 131 221 V15.0.0 (2018-07)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Foreword
This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or
GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables.
The cross reference between GSM, UMTS, 3GPP and ETSI identities can be found under
.
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
---------------------- Page: 3 ----------------------
3GPP TS 31.221 version 15.0.0 Release 15 3 ETSI TS 131 221 V15.0.0 (2018-07)
Contents
Intellectual Property Rights . 2
Foreword . 2
Modal verbs terminology . 2
Foreword . 4
1 Scope . 5
2 References . 5
3 Definitions, symbols and abbreviations . 6
3.1 Definitions . 6
3.2 Symbols . 6
3.3 Abbreviations . 6
4 Contact manager internal interface characteristics . 6
4.1 Reference model . 6
4.2 Data model . 7
4.3 Events registration and deregistration . 8
4.3.1 Overview . 8
4.3.2 Definition of events . 8
4.4 Services invocation. 9
4.4.1 General . 9
4.4.2 Services invocation API description . 9
4.4.2.1 View interfaces . 9
4.4.2.2 Lists access interfaces . 10
4.4.2.3 Items update interfaces . 11
4.4.2.4 Access control . 11
4.4.3 API classes and interfaces detailed description . 12
TM
Annex A (normative): Java Card platform Contact Manager API . 13
TM
Annex B (normative): Java Card platform Contact Manager API identifiers . 14
TM
Annex C (normative): Java Card platform Contact Manager API package version
management . 15
TM
Annex D (informative): Example of Java Card platform Contact Manager API use . 16
Annex E (informative): Change history . 17
History . 18
ETSI
---------------------- Page: 4 ----------------------
3GPP TS 31.221 version 15.0.0 Release 15 4 ETSI TS 131 221 V15.0.0 (2018-07)
Foreword
rd
This Technical Specification has been produced by the 3 Generation Partnership Project (3GPP).
The contents of the present document are subject to continuing work within the TSG and may change following formal
TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an
identifying change of release date and an increase in version number as follows:
Version x.y.z
where:
x the first digit:
1 presented to TSG for information;
2 presented to TSG for approval;
3 or greater indicates TSG approved document under change control.
y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections,
updates, etc.
z the third digit is incremented when editorial only changes have been incorporated in the document.
ETSI
---------------------- Page: 5 ----------------------
3GPP TS 31.221 version 15.0.0 Release 15 5 ETSI TS 131 221 V15.0.0 (2018-07)
1 Scope
The present document defines the internal interface characteristics of the Contact Manager for 3GPP UICC applications
[2].
The internal interface between the Contact Manager Server application on the UICC and the Contact Manager Client
application on the UICC enables Java Card™ platform based applets, defined in [3], [4] and [5], to invoke and register
to the Contact Manager Server services. In particular, the Contact Manager Java Card™ based API provides methods
to:
- Read/Update/Create/Delete contact(s) in the Contact Manager Server;
- Manage group of contacts in the Contact Manager Server;
- Search for a contact in the Contact Manager Server storage;
- manage the contacts structure;
- Register/Un-register the application to pre-defined events (e.g. application to be notified when contacts are
modified in the Contact Manager Server).
This API allows to develop an application running together with a Contact Manager [2].
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present
document.
• References are either specific (identified by date of publication, edition number, version number, etc.) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including
a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same
Release as the present document.
[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
[2] 3GPP TS 31.220: "Characteristics of the Contact Manager for 3GPP UICC applications".
[3] Sun Microsystems "Application Programming Interface, Java Card™ Platform, 3.0.1 Classic
Edition".
[4] Sun Microsystems "Runtime Environment Specification, Java Card™ Platform, 3.0.1 Classic
Edition".
[5] Sun Microsystems "Virtual Machine Specification Java Card™ Platform, 3.0.1 Classic Edition".
Note: SUN Java Card™ Specifications can be downloaded at
http://java.sun.com/products/javacard
[6] 3GPP TS 31.130: "(U)SIM API for Java™ Card".
[7] ETSI TS 101 220: "Smart cards; ETSI numbering system for telecommunication application
providers".
ETSI
---------------------- Page: 6 ----------------------
3GPP TS 31.221 version 15.0.0 Release 15 6 ETSI TS 131 221 V15.0.0 (2018-07)
3 Definitions, symbols and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and TS 31.130 [6] apply. A
term defined in TS 31.130 [6] takes precedence over the definition of the same term, if any, in TR 21.905 [1].
3.2 Symbols
For the purposes of the present document, the following symbols apply:
|| Concatenation
3.3 Abbreviations
For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An
abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in
TR 21.905 [1].
API Application Programming Interface
4 Contact manager internal interface characteristics
4.1 Reference model
The present section describes an API and a Contact Manager Runtime Environment that enables Java Card™ platform
based applets, defined in [3], [4] and [5], to invoke and register to the Contact Manager Server services (e.g.
retrieve/modify contact information). The Contact Manager Runtime Environment API is further described in annex A.
SCWS Contact
102 221 based Other Toolkit Applet
Applications Applications (e.g . Toolkit Manager
(e. g. SIM not based on service,
Server
Applet or 102 221 Remote
USIM Applet) Management
Applications,
ADF File Browser
System Server Applications)
TM
uicc.scws
Java Card uicc.access uicc.toolkit uicc.system
uicc.contactManager
package
Packages package package package
package
...