LiveCycle Data Services for ColdFusion Developers

LCDS Data Management
for ColdFusion Developers

Steven Erat
Quality Assurance Engineer
Pongo Resume, LLC

stevenerat@gmail.com

Who am I?
What I do professionally:
• 10 years experience with ColdFusion
• 6 years experience with Flex
• 4 years experience with LiveCycle Data Services
• Software Quality Assurance for Flex/CF apps - Pongo
• Flex SDK Quality Assurance Engineer - Adobe
• ColdFusion Quality Assurance Engineer - Adobe (Assigned testing for LCDS)
• ColdFusion Gold Support Engineer - Allaire > Macromedia > Adobe
What I do in my spare time:
• Red Hat Linux Certiﬁed Engineer
• talkingtree.com - Presently its my “occasional” blog for web related topics
• stevenerat.com - Professional Photographer... My “other” life

Steven Erat - LiveCycle DataServices for ColdFusion Developers - cf.Objective() - 2010

Demo: Contact Manager


History of LCDS
Flex 1.0 (includes the SDK and Server) – Released March 2004
Flex 1.5 – Released Nov 2004
FDS (Flex Data Services) was decoupled from the Flex SDK in Flex 2.0 – Released 2006
FDS was renamed LiveCycle Data Services – released as LC DS 2.5 in summer 2007
LCDS 2.5.1 in fall 2007
An open source version of remoting and messaging was released as Blaze DS in early 2008
LCDS 2.6 was released in mid 2008
LCDS 2.6.1 was released in Nov 2008
LCDS 3.0 released Nov 2009

source: http://anilchannappa.org/2008/11/26/history-ﬂex-lc-ds-fds-and-blazeds/

ColdFusion MX 7.02 ﬁrst integrated with Flex Data Services (mid 2006)
ColdFusion 8.0 tightly integrated LCDS Express Edition (install option) (mid 2007)
ColdFusion 9.0 de-integrated LCDS (Sept 2009)
- Download “LCDS Components” and LCDS 2.6.1 for manual installation


LCDS Features
Messaging
• mx:Producer, mx:Consumer
• “pub / sub”
RPC Services
• mx:HTTPService, mx:WebService, mx:RemoteObject
• Proxy, white list, client authentication
Data Management
• mx:DataService
• Data Synchronization
• Conﬂict Resolution
• Pagination
• Ofﬂine data persistence support (AIR)
• Channels: AMF; RTMP, NIO
Enterprise Support from Adobe


BlazeDS Features
Messaging
•mx:Producer, mx:Consumer
•“pub / sub”
RPC Services
•mx:HTTPService, mx:WebService, mx:RemoteObject
•Proxy, white list, client authentication
Data Management
•mx:DataService
•Data Synchronization
•Conﬂict Resolution
•Pagination
•Ofﬂine data persistence support (AIR)
•Channels: AMF; RTMP, NIO
Enterprise Support from Adobe
Open Source
Free
AMF over HTTP channel (no RTMP)


LCDS Editions
BlazeDS
•Open source and free
•Provides Messaging and RPC services
•AMF and HTTP channels, but not RTMP
•Hundreds of clients per CPU
• Some support options for additional purchase
LCDS Community Edition
•Exactly the same as BlazeDS but with Adobe support
LCDS Single CPU Edition (Express Edition) - (No longer available in LCDS 3)
•Free
•Messaging, RPC, and Data Management
•AMF, HTTP, and RTMP channels
•Thousands per CPU with RTMP / NIO channels
•Shipped in CF8; Free to manually integrate/use with CF9
LiveCycle DataServices ES2
• ~$60k/2CPU (min 2cpu)

LCDS Architecture (Integrated w/ CF)


Advantages of Using LCDS with ColdFusion

ColdFusion is awesome!

Integrates into same JVM (ColdFusion 8, 9)
•Faster than connecting CF to LCDS over RMI
ColdFusion DataServices Adapter
•Translates ColdFusion objects to ActionScript objects (& vice versa)
ColdFusion Data Management Event Gateway (ColdFusion 8, 9)
•Modify data in ColdFusion, notiﬁes LCDS of changes, LCDS notiﬁes connected clients
ColdFusion CFC Wizard in Flex Builder
•Extension for Flex Builder 3
•Generates the required CFCs: Assembler, DAO,VO
•Generates the ActionScript VO


CF8: Integrated LCDS Installer


CF9: Manual LCDS Integration
Due to ColdFusion 9’s “Enhanced Flash Remoting”, LCDS not an install option
Download “LiveCycle Data Services 2.6.1 Components” & LCDS DataServices ES2
Follow instructions in the README
********************************************************************
INSTRUCTIONS FOR MANUAL INTEGRATION OF LCDS 2.6.1 WITH COLDFUSION 9
********************************************************************
To be able to use LiveCycle Data Services ES 2.6.1 with ColdFusion 9, you need to manually integrate it with ColdFusion installation.
Note: The following instructions use the term lcds_install_root to refer to the installated home directory for LiveCycle Data Services ES 2.6.1.
1) Shutdown your ColdFusion 9 server if its running.
2) Copy the ColdFusion9/lib/flex-messaging*.jar files to a backup location. If you are running a multiserver instance or a J2EE installation, these files are in the WEB-INF/cfusion/lib
directory.
3) Copy the lcds_install_root/resources/lib/flex-messaging*.jar files and overwrite them into the ColdFusion /lib directory.
4) Copy "LCDS2.6.1_for_CF9/WEB-INF/flex/jars/cfdataservicesadapter.jar" to ColdFusion WEB-INF/flex/jars.
5) Also Copy the following SWC libraries from lcds_install_root/resources/frameworks to the CF9 directory:

ï /libs/fds.swc file to the /WEB-INF/flex/libs directory

ï /libs/player/playerfds.swc file to the /WEB-INF/flex/libs/player/ directory

ï /locale/en_US/fds_rb.swc file over the /WEB-INF/flex/locale/en_US/ directory
Old Style(CF8 style) Flash Remoting steps
=========================================
6) Copy your CF8 WEB-INF/flex/ *.xml config files to ColdFusion 9 WEB-INF/flex/ folder
7) Start ColdFusion server.
Enhanced Flash Remoting of CF9 steps
====================================
6) copy *.xml files from LCDS2.6.1_for_CF9/WEB-INF/flex directory to ColdFusion 9 WEB-INF/flex/.
7) If your LiveCycle Data Services applications use RTMP channel, open the ColdFusion WEB-INF/flex/services-config.xml file and uncomment "cf-rtmp" channel. By default it is
commented.
8) If your old Channels( in service-config.xml) has the <instantiate-types> present under <serialization> xml tag, then either remove <instantiate-types>, or set it to true. Also set the
<enable-small-messages> to False.
9) Add your data management destinations from the old file to the new data-management-config.xml file. In ColdFusion 9 release, there are few changes in the destination and channel
structure due to changes in the serialization process.
The following properties have been moved from destination to channel level. You need to move these properties under <channel-definition > --> <properites> --> <coldfusion> from your
For details, see "Changes in the XML configuration files for New Flash Remoting" in ColdFusion 9 Documentation.
10) Deploy your LCDS/Flex applications after recompiling them using new *-config.xml files, which has above mentioned changes
11) Start ColdFusion server.


CF Admin: Flex Integration


Configuration Files
WEB-INF/flex
* services-config.xml
* data-management-config.xml


Configuration Files: Channels
services-config.xml > channels (abbreviated)
<channels>

<channel-definition id="my-cfamf" class="mx.messaging.channels.AMFChannel">
<endpoint uri="http://{server.name}:{server.port}{context.root}/flex2gateway/" class="flex.messaging.endpoints.AMFEndpoint"/>
...
</channel-definition>

<channel-definition id="cf-polling-amf" class="mx.messaging.channels.AMFChannel">
<endpoint uri="http://{server.name}:{server.port}{context.root}/flex2gateway/cfamfpolling" class="flex.messaging.endpoints.AMFEndpoint"/>
<properties>
<polling-enabled>true</polling-enabled>
<polling-interval-seconds>8</polling-interval-seconds>
...
</properties>

Configuration Files: Debugging
services-config.xml > debugging (use for development only)

<logging>
<target class="flex.messaging.log.ConsoleTarget" level="Debug">

<properties>
<prefix>[LCDS-CF9] </prefix>
<includeDate>true</includeDate>
<includeTime>true</includeTime>
<includeLevel>true</includeLevel>
<includeCategory>true</includeCategory>
</properties>

<filters>
<pattern>Endpoint.*</pattern>
<pattern>Service.*</pattern>
<pattern>Configuration</pattern>
<pattern>Message.*</pattern>


<pattern>DataService.coldfusion</pattern>
</filters>
</target>
</logging>

Configuration Files: Debug Output
cfserver.log or {servername}-event.log
11/12 12:23:14 user MessageBrokerServlet: init
[LCDS-CF9]11/12/2009 12:23:15.204 [INFO] [Configuration] Adobe LiveCycle Data Services: 2.6.0.213876
[LCDS-CF9]11/12/2009 12:23:15.296 [INFO] [Configuration] Endpoint my-cfamf-secure created with security: None
at URL: https://{server.name}:{server.port}{context.root}/flex2gateway/cfamfsecure
[LCDS-CF9]11/12/2009 12:23:15.297 [INFO] [Configuration] Endpoint java-amf created with security: None
at URL: http://{server.name}:{server.port}{context.root}/flex2gateway/amf
[LCDS-CF9]11/12/2009 12:23:15.298 [INFO] [Configuration] Endpoint java-polling-amf created with security: None
at URL: http://{server.name}:{server.port}{context.root}/flex2gateway/amfpolling
[LCDS-CF9]11/12/2009 12:23:15.299 [INFO] [Configuration] Endpoint java-secure-http created with security: None
at URL: https://{server.name}:{server.port}{context.root}/flex2gateway/httpsecure
[LCDS-CF9]11/12/2009 12:23:15.374 [INFO] [Configuration] Endpoint cf-rtmp created with security: None
at URL: rtmp://{server.name}:2048
[LCDS-CF9]11/12/2009 12:23:15.375 [INFO] [Configuration] Endpoint java-secure-amf created with security: None
at URL: https://{server.name}:{server.port}{context.root}/flex2gateway/amfsecure
[LCDS-CF9]11/12/2009 12:23:15.375 [INFO] [Configuration] Endpoint java-http created with security: None
at URL: http://{server.name}:{server.port}{context.root}/flex2gateway/http
[LCDS-CF9]11/12/2009 12:23:15.376 [INFO] [Configuration] Endpoint my-cfamf created with security: None
at URL: http://{server.name}:{server.port}{context.root}/flex2gateway/
[LCDS-CF9]11/12/2009 12:23:15.376 [INFO] [Configuration] Endpoint cf-polling-amf created with security: None
at URL: http://{server.name}:{server.port}{context.root}/flex2gateway/cfamfpolling
[LCDS-CF9]11/12/2009 12:23:15.468 [INFO] [Message.coldfusion] [CFEventGatewayAdapter] Configuring ColdFusion Event Gateway adapter for destination
ColdFusionGateway
[LCDS-CF9]11/12/2009 12:23:15.521 [INFO] [DataService.coldfusion] [CFDataServicesAdapter] Configuring CFC adapter for destination
cfcontact
[LCDS-CF9]11/12/2009 12:23:15.528 [DEBUG] [Configuration] MessageBroker id: __default__ classLoader is: the MessageBroker's class loader and the context
class loader (classLoader hashCode: 14529255 (parent hashCode: 9732842 (parent hashCode: 6635780 (parent hashCode: 2293223 (parent hashCode: 5035392
(parent system)))))
[LCDS-CF9]11/12/2009 12:23:15.566 [INFO] [Configuration] Starting Adobe LiveCycle Data Services: 2.6.0.213876 Single CPU License
11/12 12:23:15 user ServerCFCServlet: init
Server coldfusion ready (startup time: 12 seconds)


Configuration Files: Adapters
data-management-config.xml > adapters
<adapters>
<adapter-definition id="coldfusion-dao" class="coldfusion.flex.CFDataServicesAdapter" default="true"/>
<adapter-definition id="actionscript" class="flex.data.adapters.ASObjectAdapter" />
<adapter-definition id="java-dao" class="flex.data.adapters.JavaAdapter"/>
</adapters>


Conﬁguration Files: Destinations
data-management-conﬁg.xml > destination > cfcontact (example destination, abbreviated)

<destination id="cfcontact">
<adapter ref="coldfusion-dao"/>
<channels>

<channel ref="cf-polling-amf"/>
</channels>
<properties>
<component>samples.contact.ContactAssembler</component>
<scope>request</scope>
<use-accessors>true</use-accessors>
<use-structs>false</use-structs>



...
<property-case>
<force-cfc-lowercase>false</force-cfc-lowercase>
<force-query-lowercase>false</force-query-lowercase>
<force-struct-lowercase>false</force-struct-lowercase>
</property-case>
<metadata>
<identity property="contactId"/>

</metadata>
<network>


</network>

Config File Changes in ColdFusion 9
When CF9 is configured for integrated LCDS, there are rearrangement of properties for
ColdFusion channels and destinations: services-config.xml
<channel-definition id="cf-polling-amf" class="mx.messaging.channels.AMFChannel">
<endpoint uri="http://{server.name}:{server.port}{context.root}/flex2gateway/cfamfpolling" class="coldfusion.flash.messaging.CFAMFEndPoint"/>
<properties>
<polling-enabled>true</polling-enabled>
<polling-interval-seconds>8</polling-interval-seconds>
<coldfusion>

<access>

<use-mappings>true</use-mappings>

<method-access-level>remote</method-access-level>
</access>

<use-accessors>true</use-accessors>

<use-structs>false</use-structs>
<property-case>

<force-cfc-lowercase>false</force-cfc-lowercase>

<force-query-lowercase>false</force-query-lowercase>

<force-struct-lowercase>false</force-struct-lowercase>
</property-case>

</coldfusion>
</properties>

Runtime Dynamic Conﬁguration
Dynamic options for Channels: Flex client side
<mx:channelSet>
<mx:ChannelSet>
<mx:channels>
<mx:AMFChannel id="myAmf"
uri="http://myserver:2000/myapp/messagebroker/amf"/>
</mx:channels>
</mx:ChannelSet>
</mx:channelSet>

Dynamic options for Destinations: BootstrapService in Java on server side

Configuring components with a bootstrap service
To dynamically configure components at server startup, create a custom Java class that extends the
flex.messaging.services.AbstractBootstrapService class and implements the initialize() method of the AbstractBootstrapService class.
You can also implement the start(), and stop() methods of the AbstractBootstrapService class; these methods provide hooks to server
startup and shutdown in case you need to do special processing, such as starting or stopping the database as the server starts or stops.
•public abstract void initialize(String id, ConfigMap properties)
•public abstract void start()
•public abstract void stop()
<services>
<service class="dev.service.MyBootstrapService1" id="bootstrap1"/>


Assembler Methods
The LiveCycle Data Management Service recognizes the methods:
Fill( ), Sync( ), Get( ), and Count( ) <--- Required
FillContains( ) <--- Optional, better performance
The fill method retrieves records from a database and populates an array with the records. The get method retrieves a
specific record. The sync method lets you keep track of synchronization conflicts by accepting a change list, which is an
array of change objects. The count method returns a number that indicates how many records are in a result set.
To perform any of these database tasks, the Flex application calls the appropriate fill, get, sync, or count method in the
assembler CFC. You can also use a fillContains method, which checks whether to update the results of a fill.
When you create your ColdFusion CFCs, you can do one of the following:
• Create an assembler CFC and a Value Object CFC.
• Create an assembler CFC, a Data Access Object (DAO) CFC, and a Value Object (VO) CFC.
You can place the database manipulation functionality directly in the methods in the assembler CFC and create a Value Object CFC, which
is a CFC that contains property definitions and related get and set methods.
Or to separate the lower level database functionality from the high-level Flex assembler operations, you can create a Data Access Object
(DAO) CFC that contains the lower level database functionality. Using this approach, which is the Bean/DAO methodology, requires that
you place the fill, get, sync, and count methods in the assembler CFC.
The methods in the assembler CFC call methods in the DAO CFC that perform the lower level database functions such as retrieving
records. The DAO CFC creates Value Objects, which are CFCs that contain the values. A Value Object is essentially a row in the result set.


Flex Project: LCDS / ColdFusion
Type: Web Application; Server: ColdFusion, LiveCycle Data Services


CFC Wizard
Create RDS Connection, then Right Click on table in Dataview


CFC Wizard
Choose CFC Type: LiveCycle Data Services Assembler CFCs


CFC Wizard
Generated for you: Assembler, DAO, VO CFCs; ActionScript VO

To Do: Write the main MXML for DataService UI


ColdFusion Assembler CFC
Assembler Methods: Fill( ), Sync( ), Get( ), Count( ) required,
and optional FillContains( )


Assembler: Fill( ) returns array of CFCs (Value Objects). Calls DAO’s Read( )


Assembler: FillContains( )


ColdFusion DAO CFC
DAO: functions: Create( ), Read( ), Update( ), Delete( ) - Abstracted away from Assembler


ColdFusion DAO CFC
DAO: query operations performed, converted to Array of CFCs (VOs)


ColdFusion Value Object CFC
Value Object Pattern: Represents one row in table, with getter/setter methods


Flex Client: AS Value Object
ActionScript VO: Maps to CFC VO. Abstracts record in table.


Flex Client: DataService
MXML with mx:DataService component (available with fds.swc from LCDS)


Data Synchronization: Conflicts
DataConflictEvent Handler: Similar to ResultHandler, FaultHandler
Event may contain an array of conflicts
For each one, use logic to determine who wins
AcceptServer( ) or AcceptClient( )


Data Synchronization: Pagination
Pagination with Data Management

- client to LCDS Server
Fill( ) fetches all records, cached in LCDS, sends pages to client on demand
<destination ...>
<properties>
...
<network>
<paging enabled="true" pageSize="50" />
</network>
</properties>
</destination>

- server to datasource (not available with ColdFusion as backend)
Custom Fill( ) fetches pages on demand
- <paging enabled="false" pageSize="10" custom="true"/>

- implement new method signature in Assembler’s ﬁll method as:
fill(fillParameters, startIndex, numRows)


Data Management Event Gateway
Notify connected Flex clients that data was changed by server action (ColdFusion)

Using the Data Management event gateway type provided with Adobe ColdFusion, you can have
ColdFusion applications notify Adobe Flex applications when data managed by a destination has
changed. You configure the Data Management event gateway and write an application that uses
the event gateway.

Notification actions:

create, delete, deleteID, refreshfill, update, or batch.

The sendGatewayMessage( ) CFML function sends the message to the instance of the gateway.

- Your CF code modifies the data set
- You use the CF function sendGatewayMessage to issue a DM gateway message
- The Data Management Event Gateway then notifies LCDS about the data changes
- LCDS notifies all connected clients that care about the data


Create new Contact as CFC
Commit new Contact to Database with DAO
Notify Event Gateway with sendGatewayMessage( )


Simple LCDS Data Management Demo
A “Hello World” type LiveCycle DataService example from beginning to end

- Flex Builder 3
- Flex SDK 3.x client side
- ColdFusion 8/9 back end
- Use CFC Wizard to generate code

ColdFusion Extensions with CFC Wizard not yet available for Flash Builder 4 (CF ER# 82729)


Learn: Tour de Flex


Learn: Books

http://www.slinnbooks.com/


Learn: LCDS Channel / Dest Designer

Create Channels and Destinations with this wizard
(available with book purchase http://www.slinnbooks.com)


Learn: Online Presentations
See Charlie Arehart’s UGTV for directory listing of recorded presentations
http://www.carehart.org/ugtv

BlazeDS and LiveCycle Data Services for ColdFusion 8
Tom Jordahl, Adobe

LiveCycle Data Services
Christophe Coenraets, Adobe

BlazeDS and ColdFusion 9...Going Above and Beyond Chat
Dave Ferguson

ColdFusion, LCDS, and Flex Magic
Nick Kwiatkowski


Learn: Complex Relationships
Text


LCDS Data Management
for ColdFusion Developers

Steven Erat

stevenerat@gmail.com
twitter: @stevenerat
http://www.talkingtree.com/
http://www.stevenerat.com/

LiveCycle Data Services for ColdFusion Developers

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

Similaire à LiveCycle Data Services for ColdFusion Developers

Similaire à LiveCycle Data Services for ColdFusion Developers (20)

Dernier

Dernier (20)

LiveCycle Data Services for ColdFusion Developers