OData App Development using Messaging Channel - SAP Help Portal

102 Pages·2014·0.56 MB·English

by  Sybase, Inc.

OData App Development using Messaging
Channel
SAP Mobile Platform 3.0 SP03
DOCUMENT ID: DC-01-0303-01
LAST REVISED: April 2014
Copyright © 2014 by SAP AG or an SAP affiliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of
SAP AG. The information contained herein may be changed without prior notice.
Some software products marketed by SAP AG and its distributors contain proprietary software components of other software
vendors. National product specifications may vary.
These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only,
without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the
materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty
statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional
warranty.
SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered
trademarks of SAP AG in Germany and other countries. Please see http://www.sap.com/corporate-en/legal/copyright/
index.epx#trademark for additional trademark information and notices.
Contents
CHAPTER 1: Overview....................................................1
OData SDK Components — General Description...............1
Documentation Roadmap for SAP Mobile Platform...........3
CHAPTER 2: Developing BlackBerry Applications......5
Getting Started Task Flow for BlackBerry Applications
.............................................................................................5
Configuring the BlackBerry Developer Environment.......6
Installing the BlackBerry Development
Environment......................................................6
Creating Projects and Adding Libraries into the
BlackBerry Development Environment.......................7
Adding Required .jar Files.....................................8
Consuming Java .JAR files for BlackBerry
Projects.............................................................8
Development Task Flow for BlackBerry Applications........9
Initializing the Application.............................................10
Registering Listeners for Push Notifications........10
Enabling Online Push..........................................11
Setting Server Details...................................................11
Registering a User........................................................11
Sending Data Request to the Back-end.......................12
Creating a URL Request......................................12
Enabling XSRF Token Protection.........................13
Assigning Credentials..........................................13
Adding Custom Headers......................................13
Setting the Required Timeout..............................14
Forwarding the Request.......................................14
Retrieving the Response from the Back-end................14
OData App Development using Messaging Channel iii
Contents
Using HTTPS over the SAP Mobile
PlatformMessaging Channel....................................14
Enabling HTTPS as a Transport Protocol............15
Verifying a Server Certificate...............................15
Enabling a Listener for HTTPS Support with
Basic Authentication Challenge.......................15
Registering a Listener for HTTP Error in
BlackBerry Applications...................................16
Debugging Runtime Error and Performance Analysis
..................................................................................17
Analyzing Performance Data Points....................17
Deploying Applications to Devices....................................19
Signing .........................................................................19
Provisioning Options for BlackBerry Devices................19
BES Provisioning for BlackBerry..................................20
BlackBerry Desktop Manager Provisioning..................20
OData SDK Components and APIs....................................21
SDMParser...................................................................22
ETag Support.......................................................27
Examples.............................................................27
SDMCache...................................................................28
SDMCache Public APIs.......................................28
SDMPersistence...........................................................29
SDMPersistence Public APIs...............................29
SDMConnectivity..........................................................33
SDMConnectivity Public APIs..............................33
SDMRequest.......................................................35
SDMResponse.....................................................37
ETag Support.......................................................38
SDMConfiguration........................................................39
SDMConfiguration Public APIs............................39
SDMSupportability........................................................40
SDMLogger..........................................................40
SAP Passport......................................................41
ODP SDK API Usage............................................................41
iv SAP Mobile Platform
Contents
Security APIs................................................................42
DataVault.............................................................42
ODP SDK API Reference for BlackBerry......................60
client package......................................................60
CHAPTER 3: Using a Reverse Proxy for OData
Applications...............................................................89
CHAPTER 4: Using REST API Services with Online
Data Proxy..................................................................91
Index ...........................................................................................93
OData App Development using Messaging Channel v
Contents
vi SAP Mobile Platform
Overview
CHAPTER 1
This guide describes how to build applications for BlackBerry devices using the OData SDK.
OData for SAP Products
OData stands for "Open Data Protocol" and is a resource-based web protocol for querying and
updating data. It is released by Microsoft under the Open Specification Promise to allow
anyone to freely interoperate with OData implementations. OData defines operations on
resources using HTTP verbs (GET, PUT, POST, and DELETE), and it identifies those
resources using a standard URI syntax. Data is transferred over HTTP/HTTPS using the Atom
or JSON format.
OData for SAP® Products provide SAP Extensions to the OData protocol that enable users to
build user interfaces for accessing the data published via OData. The interfaces require
human-readable, language-dependent labels for all properties and free-text search within
collections of similar entities and across (OpenSearch).
Applications running on mobile devices also require semantic annotations to tell the client
which of the OData properties contain a phone number, a part of a name or address, or
something related to a calendar event, thus seamlessly integrating with the contacts, calendar,
and telephony of the mobile device. The OData standard's metadata document contains
information about the model. It will define what information is searchable, which properties
may be used in filter expressions, and which properties of an entity will always be managed by
the server.
For the sake of simplicity, "OData for SAP" is abbreviated to "OData" throughout this Guide.
Related Information
For supporting information, see:
• Developer Guide: Migrating to SAP Mobile SDK.
• Supported Hardware and Software
• New Features.
OData SDK Components — General Description
The different components of the OData SDK are implemented as static runtime libraries and
each component can be used independently.
The OData SDK is used for building native mobile applications. It consists of a collection of
runtime libraries and classes. The OData SDK supports the BlackBerry platform and it is
based on the native device SDK of the platform. Native applications installed on BlackBerry
OData App Development using Messaging Channel 1
CHAPTER 1: Overview
devices allow the client application to leverage the support provided by the platform, for
example:
• Adapt to each device’s form factor (for example, automatic layout)
• Exploit different input methods (for example, touch screen, keyboard or trackball)
• Cache data in native device data stores for better performance
• Tightly integrate with the features of the device
The general description of the SDK components follows. For a detailed platform specific
description, see the respective chapter on BlackBerry.For detailed platform specific
descriptions, see the respective chapters on Android, BlackBerry and iOS.
The following components are included in the OData SDK. See the detailed platform specific
descriptions in the respective sections.
OData Parser
Parses and generates valid OData Protocol messages to/from native objects. It eliminates the
need for mobile developers to work with the low-level details of the OData protocol directly.
Functionalities supported by this component include:
• Parsing OData XML structures to native OData objects
• Validating OData XML during parsing by checking the existence of mandatory fields and
structures
• Providing easy access to all OData fields and structures via the objects resulting from the
parsing
• Building OData XML structures from native OData objects
Cache Management
The runtime cache is responsible for storing and accessing OData related objects in the
memory of the device for quick and easy access. Functionalities supported by this component
include:
• Storing/accessing OData objects in the memory (both metadata and application data)
• Searching for OData entries in memory using their searchable fields
• Managing the size of the cache
Persistence
Implements a convenient and secure storage of data on the device. Mobile applications can
access the locally stored data even when network connection is unavailable. Functionalities
supported by this component include:
• Storing objects and raw data on the physical storage of the device
• Easy and quick access of the stored objects and raw data
• Data encryption for sensitive data
2 SAP Mobile Platform
CHAPTER 1: Overview
Supportability
Implements standard SAP logging, tracing and error handling to enable end-to-end
supportability from client to back-end. Functionalities supported by this component include:
• Common exception and error handling
• Event logging
• Tracing (SAP Passport)
Connectivity
This connectivity layer handles all connectivity related tasks, hides the complexity of the
communication at transport level, and provides an easy to use API to the applications.
Productive enterprise applications must use SAP Mobile Platform for connectivity for all
enterprise use cases. For development and demo purposes, the SDK also provides a possibility
to use HTTP or HTTPS. Functionalities supported by this component include:
• Synchronous and asynchronous HTTP request handling
• Supported authentication are:
• X509 certification
• SSO token/cookie
• Basic authentication (user/password)
• Timeout handling
• Compressed payload handling
• Request types as supported by OData Protocol
• Connection pools for optimal performance
Documentation Roadmap for SAP Mobile Platform
SAP® Mobile Platform documents are available for administrative and mobile development
user roles. Some administrative documents are also used in the development and test
environment; some documents are used by all users.
See Documentation Roadmap in Fundamentals for document descriptions by user role.
Check the Product Documentation Web site regularly for updates: http://sybooks.sybase.com/
sybooks/sybooks.xhtml?id=1289&c=firsttab&a=0&p=categories, then
navigate to the most current version.
OData App Development using Messaging Channel 3
CHAPTER 1: Overview
4 SAP Mobile Platform