© 2012 Adobe Systems Incorporated and its licensors. All rights reserved.
Contents |
To compile an application, Flash Builder and mxmlc reference the SWC library files that ship with the Flex SDK in subdirectories of the frameworks directory. In Flash Builder, the frameworks directories for different Flex SDK versions are in the install_root/sdks/sdk_version directory.
Data Services ships with a set of SWC files that are compatible with the Flex SDK included in the version of Flash Builder that is made available as part of this preview program.
To add the Data Services SWC files to the Flash Builder or mxmlc library path, copy the subdirectories of the install_root/resources/client-sdk/flex directory to the Flex SDK frameworks directory in Flash Builder.
For information about building and running Flex clients, see Using LiveCycle Data Services.
For information about building and running Java-based and AIR-based Android clients with Data Services, see "Create mobile and web applications" in Using LiveCycle Data Services.
For information about building and running Java clients with Data Services, see "Creating a Java Desktop application that invokes Data Services" in Using LiveCycle Data Services.
For information about building and running HTML5/JavaScript clients with Data Services, see "Create mobile and web applications" in Using Data Services.
To build and run an iOS client application that uses the Data Services iOS SDK, you must have version 3.2.5 or later of the Apple Xcode integrated development environment running on MacOS. For more information about Xcode and the exact versions of MacOS supported, see:http://developer.apple.com/technologies/tools.
Additionally, if you want to install your application to a device instead of the iOS simulator, you must purchase a developer
license from Apple. More information about this is available at:http://developer.apple.com.
The following instructions assume some level of familiarity with Xcode and general iOS development techniques. These instructions apply equally to
an existing project in which you want to use Data Services iOS SDK or a new project.
The all_load setting is required because there is a category on NSDictionary and NSArray in a static library,
and without this switch, the linker optimizes it out because it doesn't see any class methods.
You can find details here: http://developer.apple.com/library/mac/#qa/qa2006/qa1490.html.
The SDK provides two sample applications along with source: the Remoting Demo and the Trader Desktop.
The Remoting Demo is a simple view-based application that invokes an echo service on the server via remoting with some text
typed in a text field. The Trader Desktop sample application is a more advanced example of how to use the messaging features
of the SDK. See the readme.txt in each sample directory for detailed instructions.
For information on building and running an iOS client for Data Services, see "Creating Data Services iDevice Applications" in Using LiveCycle Data Services.
The Modeler, also known as the application modeling plug-in, is a tool for creating and editing Adobe application modeling technology models. The Modeler is available with the downloads. It consists of a set of Eclipse plug-ins in the lces_data_services_JEE_4_6_1_all_modeler_plugin.zip file that you install into a stand-alone Flash Builder installation.
The download supports the application modeling plug-in with Flash Builder 4.6 on the following operating systems:
Data Services for JEE runs as a JEE web application.
Note: There is no longer a separate installation option for Data Services web applications. All of the installers with the exception of AIX and HP-UX installers, install the integrated Apache Tomcat application server. All of the Web Application Archive (WAR) files are included in the root
directory of the installation. Copy or move these WAR files to install to a separate
standalone application server.
The download supports Data Services installations on the following operating systems:
The download supports Data Services installations on the following application server:
The installers include the following Web Application Archive (WAR) files:
Each WAR file is a separate, stand-alone web application. If you are using the JEE web applications configuration, you must have an existing JEE application server or servlet container available and understand web application deployment. If you do not have an existing JEE server or are not familiar with WAR file deployment, use the integrated Tomcat configuration to get started.
These installation instructions refer to the root directory where you installed Data Services as install_root.
The Data Services with integrated Tomcat installation option contains the following files and directories under the installation root:
| readme.htm | Contains overview information. | |
| dataservices.war | Data Services web application template, used as a starting point for new applications. | |
| dataservices-samples.war | Data Services sample applications. | |
| ds-console.war | Simple monitoring application for Data Services deployments. | |
| dataservices-spring.war | Data Services Spring based web application template, used as a starting point for new applications. | |
| dataservices-samples-spring.war | Data Services sample applications using Spring. | |
| license.txt | License information. | |
| /tomcat | Contains an installation of Apache Tomcat that includes Data Services, dataservices-samples, and console web applications expanded and deployed in the default server. | |
| /resources | Fully commented configuration files, and directories and files used for security, clustering, Flex Ajax Bridge, and WSRP. | |
| /sampledb | Contains an HSQLDB database used by the sample applications. |
Install Data Services in the integrated Tomcat configuration
When you install Data Services, the installer creates the dataservices-samples web application that contains sample applications, including the 30 Minute Test Drive application. The sample applications demonstrate basic capabilities and best practices for developing Data Services applications.
http://localhost:8400/dataservices-samples/ http://localhost:8400/dataservices-samples/testdrive.htm http://localhost:8400/dataservices-samples-spring/ Deploy the dataservices.war, dataservices-samples.war, ds-console.war, dataservices-spring.war, and dataservices-samples-spring.war web applications by using your application-server-specific deployment method. For example, for Tomcat, copy the web application to the webapps directory and restart the server.
Notes:
To use the model-driven development features, you must deploy the web applications as expanded directories rather than WAR files. For production, you can package web applications in compressed WAR files.
Many samples applications in dataservices-samples web application require that you deploy the web application as an expanded directory structure. When you deploy the dataservices-samples web application, make sure that you specify "dataservices-samples" as the context-root.
There are additional configuration steps for the following application server:
To use Data Services with Tomcat when not using the integrated Tomcat configuration, install support for the Java Transaction API (JTA). You might also have to install several other libraries depending on the features that you plan to use. Follow these steps after deploying the Data Services WAR files. These steps are not necessary for the integrated Tomcat installation.
<context antijarlocking="false" antiresourcelocking="false" docbase="${catalina.home}/webapps/dataservices-samples" path="/dataservices-samples" privileged="true"> <transaction factory="org.objectweb.jotm.UserTransactionFactory" jotm.timeout="60"></transaction></context> <TRANSACTION> element under the
<context> element. <valve
classname="flex.messaging.security.TomcatValve"></valve> You can now perform authentication against the current Tomcat realm. Usually, the default configuration for authentication stores user information in conf/tomcat-users.xml. See the Tomcat documentation for more information on realms. See the Data Services documentation for more information on custom authentication.
<login-command> in /WEB-INF/flex/services-config.xml in
each deployment of a Data Services WAR file. For Tomcat, ensure
that the TomcatLoginCommand is active in the <security>section:
<security><loging-command server="Tomcat"></login-command>...</security>These instructions create a configuration that matches what is distributed with Data Services. You can integrate Apache ActiveMQ 4.1.1 with earlier versions of Tomcat. You can integrate newer versions of ActiveMQ with Tomcat 6.0.x, but none of these configurations have been tested. These instructions require that you have a valid Apache Ant installation.
ant war${catalina.home}/lib/activemq4.1.1/*.jar<context-param>
<param-name>brokerURI</param-name>
<param-value>/WEB-INF/activemq.xml</param-value>
</context-param>
<listener>
<listener-class>org.apache.activemq.web.SpringBrokerContextListener</listener-class>
</listener><beans>
<broker brokername="myBroker" persistent="false" usejmx="true"
xmlns="http://activemq.org/config/1.0">
<transportconnectors>
<transportconnector name="default" uri="tcp://localhost:61716">
</transportconnector>
</transportconnectors></broker>
</beans> This configuration starts an ActiveMQ message broker with a broker name of myBroker listening for requests on the localhost network interface at port 61716.
<Context antijarlocking="false" antiresourcelocking="false"
privileged="true" reloadable="true">
<Resource brokername="myBroker" brokerurl="tcp://localhost:61716"
description="JMS Connection Factory"
factory="org.apache.activemq.jndi.JNDIReferenceFactory"
name="jms/flex/TopicConnectionFactory"
type="org.apache.activemq.ActiveMQConnectionFactory">
</Resource>
<Resource description="my Topic" factory="org.apache.activemq.jndi.JNDIReferenceFactory"
name="jms/topic /flex/simpletopic"
physicalname="FlexTopic"
type="org.apache.activemq.command.ActiveMQTopic">
</Resource>
<Resource brokername="myBroker"
brokerurl="tcp://localhost:61716"
description="JMS Connection Factory"
factory="org.apache.activemq.jndi.JNDIReferenceFactory"
name="jms/flex/QueueConnectionFactory"
type="org.apache.activemq.ActiveMQConnectionFactory">
</Resource>
<Resource description="my Queue"
factory="org.apache.activemq.jndi.JNDIReferenceFactory"
name="jms/queue/flex/simplequeue" physicalname="FlexQueue"
type="org.apache.activemq.command.ActiveMQQueue">
</Resource>
<Valve classname="flex.messaging.security.TomcatValve"></Valve>
</Context> Note: Many samples applications in dataservices-samples.war file do not function within a compressed web application. Therefore, it is advised that you deploy the dataservices-samples web application as an expanded directory structure. If you uncompress a WAR file into a subdirectory that you create, that subdirectory must match the name of the prefix of the WAR file. That directory is also the context root of the web application. To use the model-driven development features, you must deploy the web applications as expanded directories rather than WAR files; For production, you can package web applications in compressed WAR files.
There is a known Hibernate integration issue for most WebLogic versions. The LiveCycle Data Services model-driven development and Hibernate assembler features use Hibernate. The easiest solution is to put the antlr and hibernate-jpa files shipped with Data Services 4.6 in the WebLogic bootstrap classpath. The JAR files are in the WEB-INF/lib directory of the Data Services web applications.
To work around the issue, you need to add the hibernate-jpa-2.0-api-1.0.0.Final.jar and antlr-2.7.6.jar to the bootclasspath in the WebLogic start script, for example,
-Xbootclasspath/p:%DOMAIN_HOME%/applications/qa-regress/WEB-INF/lib/antlr-2.7.6.jar;%DOMAIN_HOME%/applications/qa-regress/WEB-INF/lib/hibernate-jpa-2.0-api-1.0.0.Final.jar
To use the Data Services NIO Server or standalone NIO endpoints (including RTMP) on WebSphere, the NIO server or NIO Endpoints must have access to a WebSphere WorkManager.
Configure LiveCycle Data Services for use with WebSphere
<resource-ref>
<description>Messaging WorkManager</description>
<res-ref-name>wm/MessagingWorkManager</res-ref-name>
<res-type>com.ibm.websphere.asynchbeans.WorkManager</res-type>
<res-auth>Container</res-auth>
<res-sharing-scope>Shareable</res-sharing-scope>
</resource-ref>
For example, for an NIO server:
<server id="my-nio-server" class="flex.messaging.socketserver.SocketServer">
<properties>
<websphere-workmanager-jndi-name>java:comp/env/wm/MessagingWorkManager</websphere-workmanager-jndi-name>
</properties>
</server>Or, for example, for an NIO endpoint:
<channel-definition id="my-rtmp" class="mx.messaging.channels.RTMPChannel">
<endpoint url="rtmp://{server.name}:2037" class="flex.messaging.endpoints.RTMPEndpoint"/>
<properties>
<websphere-workmanager-jndi-name>java:comp/env/wm/MessagingWorkManager</websphere-workmanager-jndi-name>
</properties>
</channel-definition>
JBoss web application deployment
You can avoid this issue in JBoss 5.1.x by copying the hibernate-validator.jar that ships with JBoss in the {jboss.root}}/common/lib directory to the WEB-INF/lib directory of your Data Services webapp so that it is loaded by the same classloader as the hibernate jars that ship with Data Services.
In JBoss 5.0.x you also need to use a jboss-classloader.xml in your web application's WEB-INF directory to tell JBoss to load jars from the web application first. See your JBoss documentation on classloading for instructions.
JBoss 4 authentication
(Optional) This configuration provides custom authentication against the current JBoss realm. Usually, the default location for this authentication stores user information in jboss_root/server/default/conf/users.properties and roles information in jboss_root/server/default/conf/roles.properties. For more information on realms, see the JBoss documentation. For more information on LiveCycle Data Services custom authentication, see the LiveCycle Data Services documentation and information in the install_root/resources/security directory.
You will now be authenticated against the current JBoss realm.
JBoss 5 authentication
This configuration provides custom authentication against the current JBoss realm:
<Valve className="flex.messaging.security.TomcatValve"/><?xml version='1.0' encoding='utf-8'?>
<tomcat-users>
<role rolename="tomcat"/>
<role rolename="role1"/>
<user username="tomcat" password="tomcat" roles="tomcat"/>
<user username="both" password="tomcat" roles="tomcat,role1"/>
<user username="role1" password="tomcat" roles="role1"/>
</tomcat-users><Realm className="org.apache.catalina.realm.MemoryRealm" pathname="../server/default/conf/tomcat-users.xml"/>SAP NetWeaver requires that Data Services and Hibernate be deployed in Enterprise Application Archive (EAR) files. To deploy Data Services on NetWeaver, perform the following steps:
<?xml version="1.0" encoding="UTF-8"?>
<application-j2ee-engine xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="application-j2ee-engine.xsd">
</application-j2ee-engine>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application-service SYSTEM "application-service.dtd" >
<application-service>
</application-service>
<SDA>
<SoftwareType>J2EE</SoftwareType>
<engine-deployment-descriptor version="2.0">
<substitution-variable>
<variable-name>com.sap.dc_name</variable-name>
</substitution-variable>
<substitution-variable>
<variable-name>com.sap.dc_vendor</variable-name>
</substitution-variable>
<substitution-variable>
<variable-name>com.sap.sld.GatewayHost</variable-name>
</substitution-variable>
<substitution-variable>
<variable-name>com.sap.sld.GatewayService</variable-name>
</substitution-variable>
</engine-deployment-descriptor>
</SDA>
ds-sap-connector-hibernate.ear
|--lib
|--antlr-2.7.6.jar
|--commons-collections-3.1.jar
|--dom4j-1.6.1.jar
|--hibernate-3.6.6.jar
|--hibernate-jpa-2.0-api-1.0.1.Final.jar
|--javassist-3.15.GA.jar
|--slf4j-api-1.6.1.jar
|--META-INF
|--MANIFEST.MF
|--SAP_MANIFEST.MF
|--sda-dd.xml
|--application-j2ee-engine.xml
|--application-service.xml
<reference
reference-type="hard">
<reference-target
provider-name="com.adobe"
target-type="application">LiveCycleDataServicesHibernate</reference-target>
</reference>
When running Data Services from a compressed WAR in WebLogic 11, in order to deploy or persist models you must set the model-persistence-directory property in the services-config.xml file with a fully qualified path. For example:
<!--
The Model Deployment Service deploys data models on server startup.
The persistence class can be configured if needed.
The default FilePersistence implementation can be configured with an alternative storage directory.
By default the /WEB-INF/datamodel directory in the web application is used.
Make sure to use a full directory path.
-->
<service id="model-deploy-service">
<!-- Generally you do not need to override the defaults -->
<!--
<properties>
<model-persistence-class>fiber.data.services.FilePersistence</model-persistence-class>
<model-persistence-directory>/path/to/model/directory</model-persistence-directory>
</properties>
-->
</service>
The Edge Server is a standard Data Services server specially configured and deployed in an organization’s demilitarized zone (DMZ), which is the subnetwork that contains and exposes an organization's external services to the Internet. The installation process for the Edge Server is identical to the installation process for a Data Services server in the application tier. The only difference is that the Edge Server is installed in the DMZ and configured to use a gateway service that communicates with a gateway endpoint on the Data Services server in the application tier.
You can download the SAP Java Connector from the SAP Service Marketplace. You must make sure that the JCo libraries are in the classpath of your Data Services application. For example, on Tomcat, you can place the JCo libraries in the Tomcat sharelib folder.
Use the services-config.xml file of the Data Services web application to configure the service that connects to the SAP server. The file contains two SapConnectorInitializationService elements that you use to configure the service. Both elements are commented out by default.
<!-- Default SAP Connector service.
Note: SAP Connector service must come before ModelDeploymentService in the config. -->
<service class="com.adobe.livecycle.sap.connector.SapConnectorInitializationService" id="sap-connector-service"/>
<!-- SAP Connector service with JCoSessionReferenceProvider. Use only one of the SapConnectorInitializationService service configurations.
If using this configuration, all SAP applications must use "PerSession" or "PerClient" authentication style. "None" style will result in a runtime exception.
Note: SAP Connector service must come before ModelDeploymentService in the config. -->
<service class="com.adobe.livecycle.sap.connector.SapConnectorInitializationService" id="sap-connector-service">
<properties>
<sap-session-provider>com.adobe.livecycle.sap.connector.JCoSessionReferenceProviderImpl</sap-session-provider>
</properties>
</service>
To enable the connector service, check the element comment and uncomment the appropriate service element.
The SAP server connection requires connection information, such as authentication credentials and connection pool setting.
Connection properties are stored in a text file in the WEB-INF/datasource/sap directory. The file extension must be .jcoDestination. Each line in the text file is a property-value pair with the following properties:
Using encrypted user credentials maximizes security. When using plain-text credentials as described here, use an SAP account that has minimum authorization for using the meta-data repository. This strategy lowers the security risk. For more information, see the SAP documentation or contact your SAP administrator.
A sample configuration file named sample-sap.jcoDestination is provided in the WEB-INF/datasource/sap directory. This file includes the following property-value pairs:
jco.client.lang=en
jco.destination.peak_limit=10
jco.client.client=001
jco.client.passwd=changeme
jco.client.user=sapuser
jco.client.sysnr=00
jco.destination.pool_capacity=2
jco.client.ashost=fully.qualified.server.name
You can integrate Data Services with Spring. The Data Services installation includes two Spring-enabled web applications:
For more information on Spring integration, see Using LiveCycle Data Services.
Once you have installed Data Services, see "Getting Started with Data Services" in Using LiveCycle Data Services for JEE for a quick introduction to features and practical information about building and deploying applications.
Installing Data Services for JEE, Version 4.6 Prerelease-- 12/05/2011 9:58 AM