A-Team Mobile Persistence Accelerator Overview

Copyright © 2016 Oracle and/or its affiliates. All rights reserved. |Copyright © 2014 Oracle and/or its affiliates. All rights reserved. |
A-Team Mobile Persistence
Accelerator (AMPA)
Superior productivity in building MAF applications
Steven Davelaar
@stevendavelaar
Oracle Mobile & Cloud A-Team

Copyright © 2016 Oracle and/or its affiliates. All rights reserved. |
What matters when building mobile apps
• User Experience
– Work in Offline Mode
• Performance
• Developer Productivity
2

How AMPA helps
• User Experience
– People can work in offline mode, no reliance on network connectivity
• Performance
– Advanced data caching mechanism
– Show on-device data immediately
– Costly remote server calls performed in background
• Development productivity
– Wizards and runtime lib significantly reduce coding effort
– Fast debugging of REST calls
– Generation of CRUD user interface for easy testing
3

What is AMPA?
• Lightweight persistence framework that works on top of MAF
• Declarative consumption of REST-JSON services
• Significantly speeds up implementation of data caching and data
synching
• Available as open source framework hosted on GitHub
• Support through OTN MAF discussion forum
• Ideas and features from this project will be included in the MAF
product over time.

Oracle MAF Architecture
Device
Services
PhoneGap/
Cordova
Device Native Container
Web
View
Server
HTML
ADF Mobile
AMX View
Third Party
Web Sites
Server or Cloud backend
Oracle IDM
Oracle IAM
Mobile
Device
Local
HTML
HTML5 & JavaScript Presentation
Configuration
Server
ADF Controller
CredentialManagement,
SSO&AccessControl
App
Config Server
SOAP & REST
Web Services
Java VM
Business Logic
ADF Model
Encrypted
SQLite DB
JDBC SQLite

Java VM on Device
Runtime Persistence Architecture
DepartmentService
Data Control
Department
DepartmentServiceEntityCRUDService
extends
DBPersistence
Manager
Persistence
Mapping XML
DEPARTMENTS
table
SQLite
uses
JDBC
Statements
references
REST(JSON)
REST-JSON
PersistenceManager
HTTP
Requests
AMPA Fwk classes
Generated by AMPA Wizards

Local and Remote Persistence
• AMPA runtime library contains generic Java code to perform CRUD
operations against SQLite database and against remote web services.
– Service objects extend EntityCRUDService class
– Service objects use DBPersistenceManager for CRUD operations against
SQLite database
– Service object can use a remote persistence manager for CRUD operations against
web service
• The generic code in EntityCRUDService class and persistence
managers is driven by metadata stored in persistence mapping XML file
• Persistence Managers are pluggable – create your own if needed

AMPA - JDeveloper Wizards
• Three wizards are provided to create the artefacts needed for this runtime
persistence architecture:
– Mobile Business Objects From REST Web Service Wizard
– Mobile Business Objects From SOAP Web Service Data Control Wizard (Deprecated,
REST performance is superior to SOAP, see next slides)
– Mobile Business Objects From Database Tables (Local persistence only)
• Another wizard is provided to generate a default CRUD user interface on
top of the business layer created by one of the above wizards.

SOAP vs REST for Mobile Applications
REST-JSON is 9x to 30x faster than SOAP!
Oracle Confidential –
9

SOAP vs REST for Mobile Applications
• Sample payload size
– 27 departments with 4 attributes and 107 nested employee attributes with 11
attributes
– Size in JSON format: 26.2 KB
– Size in XML format: 77.3KB
• Performance diff is NOT JUST caused by payload size
– XML parsing is CPU intensive and slow in MAF
– SOAP datacontrol requires reading and parsing many more files (wsdl, xsd)
• SOAP Data Control might be deprecated in future MAF version
– Too many performance issues / complaints
– Too many issues with complex SOAP services
10

A-Team Performance Study
http://www.ateam-oracle.com/performance-study-rest-vs-soap-for-mobile-applications/
11

MAF Development Process with AMPA
• Run AMPA wizard to create persistence layer artefacts
– Data objects and service classes
– Persistence mapping XML
– Sqlite DDL file to create table definitions
– Persistence configuration file
• Create Data Control(s) for Service Class(es)
• Create User Interface Layer
– Use drag and drop from Data Control Palette
– Use AMPA User Interface Generator Wizard
• Add business logic and UI logic
• Style the application to meet UI designs

Creating On-Device Persistence Layer
• Use Oracle MCS RAML specification
• Execute Sample Resource Endpoints (server connection required)
• Use Oracle ADF BC REST Describe (server connection required)
• Specify Sample Payloads
AMPA Wizard – Persistence Creation Options

Copyright © 2016 Oracle and/or its affiliates. All rights reserved. |Copyright © 2015 Oracle and/or its affiliates. All rights reserved. 14
Demo:
Creating Persistence Layer using MCS RAML

MCS API Endpoints are stored in RAML file

Creating Persistence Layer

Creating Persistence Layer – Sample Resource

Creating Persistence Layer – RAML File

Creating Persistence Layer – Data Objects

Creating Persistence Layer – Data Object Attributes

Creating Persistence Layer – Parent-Child Accessors

Creating Persistence Layer - CRUD Resources

Creating Persistence Layer – Resource Details

Creating Persistence Layer – Runtime Options

Creating Persistence Layer – Generator Settings

Persistence Layer Wizard - Output
• Data Object Java Classes
• Service Java Classes
• Persistence Mapping XML File
• SQL DDL File
• Persistence Configuration Properties File

Generated Data Object Classes

Generated Service Object Classes

Generated SQL DDL Script

Generated Persistence Mapping File

Generated Persistence Mapping File
RESTful resource calls

Generated Config File

Configured InitDBLifecycleListener

Create Data Control For Service Classes

Creating the Mobile User Interface
• Build Using Drag and Drop
from DataControl Palette
• Generate Using MAF User
Interface Generator Wizard
– Generates feature, task flow,
AMX pages, managed beans,
etc
Two Options

Building the User Interface – List View

Building the User Interface – Quick Search

Building the User Interface – Refresh List Data

Building the User Interface – Create New Entity

Building the User Interface – Remove Entity

Building the User Interface – Save Changes

Building the User Interface – Cancel Changes

Building the User Interface – Master-Detail

Using the MAF User Interface Generator

Demo:
Generating UI Layer

Generated User Interface Artefacts

AMPA - Offline Writes and Data Syncing
• If a remote persistence manager is configured, and CUD service call fails,
the service call is registered as “pending” data synch action
– Failure reason registered (device offline, service not available, etc)
• On next service call, the pending synch actions are processed first in order
of creation
– When failing again, the still pending synch action is updated with date of last synch
attempt and last error message
• Out-of-the-box feature: NO Java coding required

Viewing Pending Data Sync Actions
• A reusable “DataSync” feature is provided that can be added to your
mobile application
• Register the feature in adfmf-application.xml

Viewing Pending Data Synch Actions

Demo:
Offline Transactions and Syncing

Notes on Data Sync Functionality
• Pending changes can become obsolete because of updates in server data
by other clients
– The server–side code should identify this and throw an error when the data sync
action sends stale data
– Stale data detection can be done by including a data revision number or ‘last-
modified” timestamp in payload. This number or timestamp should match with
server-side data record
• Data sync actions that keep failing need to be removed manually
– Local database might be out-of-sync, app needs to offer reconcile action

AMPA – MCS Support
• MCS Custom API
– Complete persistence layer created for Custom API Rest endpoints
– Supports offline reads and writes
• MCS Authentication
• MCS Analytics
– Easily send custom and system events
– Supports offline mode
• MCS Storage
– Easy read and write access to storage objects
– Support for reading and writing storage objects in offline mode
– Download file only if needed – check for changes using ETag header
• MCS Push Notifications
– (un)register device
• No need to use MAF-MCS Sample Utility

MCS Support – Sending Analytics Events

MCS Support – Register Device

• Create StorageObjectService Bean Data Control
– Drag and drop from data control palette
– No Java coding required
– No data object context
• Programmatic access
– Show file content in context of custom API data objects
– For example, Show employee picture with employee data
• File download in background or foreground
– Metadata stored in SQLite DB, file stored on file system
MCS Support – Show Storage Object Content

Create StorageObjectService Data Control

Using StorageObjectService Data Control

MCS Support – Storage Object Programmatic Access
Retrieve employee images

Using Employee Picture from Data Control

Add File to MCS
https://github.com/oracle/mobile-
persistence/wiki/Developers-Guide

Remove File from MCS
https://github.com/oracle/mobile-
persistence/wiki/Developers-Guide

Debugging Support
• Show/Hide web service call errors in UI
– Configurable in persistence-mapping
• Log Rest call details
– Configurable in persistence-mapping
– Reusable feature to view REST calls at runtime

Programmatic Access to SQLite DB
• AMPA provides DBPersistenceManager class to access SQLite DB
– Many convenience methods for CRUD operations
– No need to obtain DB connection yourself
• Custom SQL Queries can be specified in two ways
– At Data Object level using finder methods with attribute key-value pairs
– At SQL level by writing SQL statement yourself
– SELECT FROM clause can be created using convenience method
• SQL Query Results can be automatically converted to data object list
– Convenience method createEntitiesFromResultSet

Query using attribute key-value pairs

Query using custom SQL WHERE clause

Custom SQL Query

Miscellaneous Features
• Encryption of database
• Auto-cleaning of unused database segments
• Lazy loading of child collections (a.k.a “Indirection”)
• Entity caching to minimize object creation
• Supports server-derived primary keys
– Temporary client key gets updated in DB and entity cache
• FindEntityByKey
– Checks cache first, then database
• Designed for customization
– Easy to override and extend default behavior
– Specify custom persistence managers in persistence-mapping.xml

More Info
• GitHub Wiki: github.com/oracle/mobile-persistence/wiki

Summary
• Use MCS to design and implement a mobile-optimized REST API
• Use AMPA to declaratively consume the REST/JSON web services
• Use AMPA to implement data caching and syncing using the on-device
SQLite database
• Use AMPA to speed up user interface development and testing
• Think about how your end users should handle failed data sync actions,
and how to prevent updates based on stale data

A-Team Mobile Persistence Accelerator Overview

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

Similaire à A-Team Mobile Persistence Accelerator Overview

Similaire à A-Team Mobile Persistence Accelerator Overview (20)

Dernier

Dernier (6)

A-Team Mobile Persistence Accelerator Overview

Notes de l'éditeur