ETSI TS 131 221-2017 Universal Mobile Telecommunications System (UMTS) LTE Contact Manager Application Programming Interface (API) Contact Manager API for Java Card (V14 0 0 3GPP T.pdf

1、 ETSI TS 131 221 V14.0.0 (2017-04) Universal Mobile Telecommunications System (UMTS); LTE; Contact Manager Application Programming Interface (API); Contact Manager API for Java Card (3GPP TS 31.221 version 14.0.0 Release 14) floppy3TECHNICAL SPECIFICATION ETSI ETSI TS 131 221 V14.0.0 (2017-04)13GPP

2、TS 31.221 version 14.0.0 Release 14Reference RTS/TSGC-0631221ve00 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 enregistre la Sous-Prfecture de Gr

3、asse (06) N 7803/88 Important notice The present document can be downloaded from: http:/www.etsi.org/standards-search 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 w

4、ithout 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 o

5、f 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 https:/portal.etsi.org/TB/ETSIDeliverableStatus.aspx If you find errors in the present document, please send you

6、r comment to one of the following services: https:/portal.etsi.org/People/CommiteeSupportStaff.aspx 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 E

7、TSI. 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. European Telecommunications Standards Institute 2017. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTMand the ETSI log

8、o are Trade Marks of ETSI registered for the benefit of its Members. 3GPPTM and LTE are Trade Marks 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 Trade Marks registered and o

9、wned by the GSM Association. ETSI ETSI TS 131 221 V14.0.0 (2017-04)23GPP TS 31.221 version 14.0.0 Release 14Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to ETSI. The information pertaining to these essential IPRs, if any, is publ

10、icly 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

11、 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

12、may become, essential to the present document. 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 s

13、hould be interpreted as being references to the corresponding ETSI deliverables. The cross reference between GSM, UMTS, 3GPP and ETSI identities can be found under http:/webapp.etsi.org/key/queryform.asp. Modal verbs terminology In the present document “shall“, “shall not“, “should“, “should not“, “

14、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 ETSI TS 131 221 V

15、14.0.0 (2017-04)33GPP TS 31.221 version 14.0.0 Release 14Contents Intellectual Property Rights 2g3Foreword . 2g3Modal verbs terminology 2g3Foreword . 4g31 Scope 5g32 References 5g33 Definitions, symbols and abbreviations . 6g33.1 Definitions 6g33.2 Symbols 6g33.3 Abbreviations . 6g34 Contact manager

16、 internal interface characteristics . 6g34.1 Reference model . 6g34.2 Data model . 7g34.3 Events registration and deregistration 8g34.3.1 Overview 8g34.3.2 Definition of events 8g34.4 Services invocation. 9g34.4.1 General 9g34.4.2 Services invocation API description . 9g34.4.2.1 View interfaces . 9g

17、34.4.2.2 Lists access interfaces . 10g34.4.2.3 Items update interfaces 11g34.4.2.4 Access control . 11g34.4.3 API classes and interfaces detailed description 12g3Annex A (normative): Java CardTMplatform Contact Manager API . 13g3Annex B (normative): Java CardTMplatform Contact Manager API identifier

18、s . 14g3Annex C (normative): Java CardTMplatform Contact Manager API package version management . 15g3Annex D (informative): Example of Java CardTMplatform Contact Manager API use 16g3Annex E (informative): Change history . 17g3History 18g3ETSI ETSI TS 131 221 V14.0.0 (2017-04)43GPP TS 31.221 versio

19、n 14.0.0 Release 14Foreword This Technical Specification has been produced by the 3rdGeneration 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 prese

20、nt 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 chan

21、ge 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 ETSI TS 131 221 V14.0.0 (2017-04)53GPP TS 31.221 version 14.0.

22、0 Release 141 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 plat

23、form 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 Manage

24、r 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

25、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-spe

26、cific. 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 Releas

27、e 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 Env

28、ironment 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:/ 6 3GPP TS 31.130: “(U)SIM API for Java Card“. 7 ETSI TS 101 220: “Smart car

29、ds; ETSI numbering system for telecommunication application providers“. ETSI ETSI TS 131 221 V14.0.0 (2017-04)63GPP TS 31.221 version 14.0.0 Release 143 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

30、 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 abbrevia

31、tions 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 Th

32、e 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

33、further described in annex A. 102 221 based Applications ( e.g. SIM Applet or USIM Applet) ADF File System Server Other Applications not based on 102 221 Toolkit Applet ( e.g. Toolkit service, Remote Management Applications, Browser Applications) SCWS uicc.system package uicc.toolkit package uicc.ac

34、cess package Java Card TM Packages CAT Runtime Environment Contact Manager Runtime Environment Java Card TM Runtime Environment Items that are defined in this specification SCWS Runtime Environment uicc.scws package uicc.contactManager package Contact Manager Server Figure 1: Internal interface refe

35、rence model ETSI ETSI TS 131 221 V14.0.0 (2017-04)73GPP TS 31.221 version 14.0.0 Release 14Contact Manager Runtime Environment: An Extension to the Java Card platform described in 345 and the (U)SAT Runtime Environment described in TS 31.130 6 to facilitate the communications between Applets and the

36、 Contact Manager Server. Applet: these derive from javacard.framework.Applet and provide the entry points: process, select, deselect, install as defined in the “Runtime Environment Specification, Java Card Platform, 3.0.1 Classic Edition“ 4. Event Listener List of the Contact Manager: this is handli

37、ng all the registration information of the event listener of the Contact Manager Server services. It is provided as a JCRE entry point object defined in 5. The registry is part of the Contact Manager Runtime Environment. Contact Manager API: consists of the package uicc.contactmanager, provides the

38、methods to register and unregister, to the Contact Manager events. It also provides methods to access the Contact Manager Server data. This API is an extension to the “(U)SAT API“ defined in TS 31 130 6. Contact Manager Server: application on the UICC that enables Java Card platform based applets, d

39、efined in 3, 4 and 5, to invoke and register to its services. The invocation of the Contact Manager Server services is done through methods corresponding to the Contact Manager Runtime Environment interface. 4.2 Data model The Contact Manager API gives the user application a view of the data stored

40、by the Contact Manager Server. This view follows the data model below: Figure 1: data model The contact manager is composed of a collection of contacts. Each contact belongs to a unique contact manager. The contact manager is also composed of a collection of field descriptors. Each field descriptor

41、defines the properties of a field that all contacts belonging to the contact manager shall have. A contact field is described by: - its type (e.g. Name, phone number, postal address,) and - its attributes (e.g. voice phone number). Some fields such as a name or a postal address may be composed of se

42、veral sub-fields. Each field descriptor belongs to a unique contact manager. A contact is composed of a collection of fields. Each field belongs to a unique contact, and defines the value assigned to this contact for a unique field descriptor. The contact manager is also composed of a collection of

43、groups. Each group belongs to a unique contact manager, and is an aggregation of contacts that belong to the same contact manager. Each contact may belong to no group, one group, or multiple groups. ETSI ETSI TS 131 221 V14.0.0 (2017-04)83GPP TS 31.221 version 14.0.0 Release 14Each contact is identi

44、fied by an identifier, which is unique among all contacts in the Contact Manager database. Each field descriptor is identified by an identifier, which is unique among all field descriptors in the Contact Manager database. Each group is identified by an identifier, which is unique among all groups in

45、 the Contact Manager database. The contact identifiers, field descriptor identifiers and group identifiers are three distinct spaces. For example, a contact may have the same identifier as a group. The following figure depicts an example of a Contact Manager Server data store. Group Work Group Famil

46、y Groups Contacts Contact 1 Joe Contact 2 Steve Field Name: Joe Field Tel: 061155 Field Email: J FieldsDescriptors List: Contact structure FieldDescriptor 1stEmail FieldDescriptor Name FieldDescriptor Cellular Phone Contact 3 Steve Figure 2: Example of a Contact Manager Server data store 4.3 Events

47、registration and deregistration 4.3.1 Overview Registration to and Deregistration from the Contact Manager Server is done through the register and unregister methods of the Contact Manager Runtime Environment interface. To be notified, the client shall implement a ContactEventListener interface and

48、register to the appropriate events. Then the Contact Manager Server will call the following methods of all registered clients when the corresponding event occurs: - ContactEventListener.contactModified (int event, int contactIdentifier) each time a contact is modified. - ContactEventListener.groupMo

49、dified (int event, int groupIdentifier, int contactIdentifier) each time a group is modified. - ContactEventListener.fieldDescriptorModified (int event, int fieldDescriptorIdentifier) each time a field descriptor is modified. 4.3.2 Definition of events The following events can notify an applet: ETSI ETSI TS 131 221 V14.0.0 (2017-04)93GPP TS 31.221 version 14.0.0 Release 14Table 1: Contact Manager events list Event Name EVENT_CONTACT_ADDED EVENT_CONTACT_MODIF