Create a Data Services application for the Experience Server that returns data

To download a package by using the Package Manager

1. To view the Adobe Digital Enterprise Platform welcome page, enter the URL http://[host name]:[port] into a web browser. For example, http://localhost:4502.

2. Enter a valid user name and password. The default value for both values is admin.

3. Click Packages.

4. Select the name of the package that corresponds to the ZIP file you want to download.

5. From the menu that appears, select Download.

6. Save the ZIP file to a folder on your local file system.

7. Extract the contents of the ZIP file.

To place the application files in the template application (Required)

1. Place the dataservices-bundle.jar that you downloaded from the Experience Server into the template application’s lib folder.

2. Under the sourceCode\src\main\java folder, create a folder structure that reflects the Java package structure. The folder structure to create the package developed in this section is sourceCode\src\main\java\com\adobe\myexample.

3. Place the following EchoService.java file in the myexample folder.

Specify the Java package to export (Required)

You specify the Java package to export by modifying the pom.xml file that is located in the sourceCode folder. If you do not specify a Java package in the pom.xml file, then an exception is thrown when a client application calls an operation that is located in your package.

To specify a Java package, specify the Java package name in the Export-Package element, as shown in the following example.

<Export-Package> 
    com.adobe.myexample 
</Export-Package>

In this example, com.adobe.myexample represents the Java package to which the EchoService class belongs. If there is more than one package, you can use a comma to separate each package.

Specifying the name of the Experience Services package (Optional)

The package folder contains XML files named pom.xml and assembly.xml that you can modify to determine the package name. The pom.xml file contains a parent element that specifies build details such as the version of the package. Under the parent element, you can modify, for example, the version attribute to specify the version of the package.

The following XML represents elements in the pom.xml file.

<?xml version="1.0"?> 
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> 
    <modelVersion>4.0.0</modelVersion> 
    <!-- ====================================================================== --> 
    <!-- P A R E N T  P R O J E C T  D E S C R I P T I O N                      --> 
    <!-- ====================================================================== --> 
    <parent> 
        <groupId>com.adobe.dataservices.example.app</groupId> 
        <artifactId>dataservices-example-app-parent</artifactId> 
        <version>1.0-SNAPSHOT</version> 
        <relativePath>../parent/pom.xml</relativePath> 
    </parent> 
 
    <!-- ====================================================================== --> 
    <!-- P R O J E C T  D E S C R I P T I O N                                   --> 
    <!-- ====================================================================== --> 
    <groupId>com.adobe.dataservices.example.app</groupId> 
    <artifactId>dataservices-example-app-package</artifactId> 
    <packaging>pom</packaging> 
    <name>Data Services Example App</name> 
 
    <properties> 
        <content.dir>${project.build.directory}/assembly</content.dir> 
        <jcr.root.dir>${project.build.directory}/assembly/jcr_root</jcr.root.dir> 
    </properties>

Another element that you can modify is artifactId. In the previous example, notice that the value of this element is dataservices-example-app-package.

The assembly.xml file also contains an XML element named id that specifies the package name. The following XML represents the assembly.xml.

<!-- 
    This file defines how to create the ZIP file. 
--> 
<assembly> 
    <id>mypackage</id> 
    <includeBaseDirectory>false</includeBaseDirectory> 
    <formats> 
        <format>zip</format> 
    </formats> 
    <fileSets> 
        <fileSet> 
            <outputDirectory>.</outputDirectory> 
            <directory>target/assembly</directory> 
        </fileSet> 
    </fileSets> 
</assembly>

Maven produces a package by using values in both the pom.xml file and the assembly.xml file. The default name of the package is dataservices-example-app-package-1.0-SNAPSHOT-mypackage.zip. The dataservices-example-app-package-1.0-SNAPSHOT value is specified in the pom.xml file. Likewise, mypackage is specified in the assembly.xml file.

Ensure that each package that you deploy to the Experience Server has a unique name. If you attempt to deploy a package that has the same name of a deployed package, then a javax.jcr.ItemExistsException is thrown.

Specifying package files to uninstall (Optional)

You use the filter.xml file to specify the package's files and folders to uninstall when you uninstall the package. If you do not specify a file or folder in the filter.xml file, then it is not uninstalled when the package is uninstalled. For example, you can specify a destination XML configuration to ensure that it is uninstalled when the package is uninstalled.

Experience Server uses the filter.xml file to take a snapshot of the contents of the files and folders listed before it installs the package. It restores the snapshot when the package is uninstalled. That is, Experience Server reverts back to the state that it was in when the snapshot was taken.

The following XML represents the filer.xml file.

<?xml version="1.0" encoding="UTF-8"?> 
<!-- 
    The filters define the paths that are *removed* when the package is un-installed.  You should update this to include any files or folders you install. 
--> 
<workspaceFilter version="1.0"> 
    <filter root="/libs/dataservices-example-app"/> 
    <filter root="/apps/dataservices-example-app"/> 
    <!-- This will ensure our destination config is removed when we are un-installed --> 
    <filter root="/etc/aep/config/dataservices/destinations/remoting"> 
        <include pattern="/etc/aep/config/dataservices/destinations/remoting/com.sample.empty.xml" /> 
    </filter> 
</workspaceFilter>

Replace com.sample.empty.xml with the name of the file that you want to uninstall when the package is uninstalled. For example, to uninstall the remoting XML configuration file that is created in this section, specify com.adobe.myexample.xml.

You can locate the filter.xml file in the template application' package folder:

package\META-INF\vault

Running Maven to create the package (Required)

You can run Maven in the Command Prompt to build the package. Maven builds a package as a ZIP file and places it in the template application’s package/target folder. If the build is successful, you will see a message in the Command Prompt similiar to the following message:

[INFO] Reactor Summary: 
[INFO] 
[INFO] Data Services Example - Parent .................... SUCCESS [0.203s] 
[INFO] Data Services Example - OSGi Bundle ............... SUCCESS [22.620s] 
[INFO] Data Services Example - Package ................... SUCCESS [1.125s] 
[INFO] ------------------------------------------------------------------------ 
[INFO] BUILD SUCCESS 
[INFO] ------------------------------------------------------------------------ 
[INFO] Total time: 24.398s 
[INFO] Finished at: Wed Aug 03 18:58:38 EDT 2011 
[INFO] Final Memory: 18M/232M

To create the package by running Maven

1. Start the Command Prompt.

2. Change the directory to the location of dataservices-example-app-template.

3. Enter the following command: %M3_HOME%\bin\mvn clean install.

To deploy a package by using the Package Manager

1. To view the Adobe Digital Enterprise Platform welcome page, enter the URL http://[host name]:[port] into a web browser. For example, http://localhost:4502.

2. Enter a valid user name and password. You can use admin for both values.

3. Click Packages.

4. From the menu bar, click Upload Package.

5. Navigate to the ZIP file that represents the package. Maven placed the ZIP file in the following folder: package/target.

6. Click OK.

7. From the new package entry menu, click Install.

8. In the Install Package dialog, click Install.

To remove a package by using the Package Manager

1. To view the Adobe Digital Enterprise Platform welcome page, enter the URL http://[host name]:[port] into a web browser. For example, http://localhost:4502.

2. Enter a valid user name and password. You can use admin for both values.

3. Click Packages.

4. Select the name of the package to delete.

5. From the menu, select More, Uninstall.

6. In the Please confirm dialog, click Uninstall.

7. From the menu, click More, Delete.

8. In the Please confirm dialog, click Delete.

Using the Apache Felix Web Console Bundles view

You can use the Apache Felix Web Console Bundles view to confirm that your package was successfully deployed. If your package was successfully deployed, then it is displayed in the bundle view. You can view details about the package such as the packages it exports.

To confirm your package was deployed using the Apache Felix Web Console Bundles view

1. To view the Adobe Digital Enterprise Platform welcome page, enter the URL http://[host name]:[port] into a web browser. For example, http://localhost:4502.

2. Enter a valid user name and password. You can use admin for both values.

3. Click OSGi console.

4. Enter a valid user name and password. You can use admin for both values.

5. Click the Bundles tab.

6. Search for your bundle. You can order the bundle by version by clicking on the Version tab.

7. Click on the arrow beside the package name to view its details.

To define the server-side destination using CRXDE Lite

1. To view the Adobe Digital Enterprise Platform welcome page, enter the URL http://[host name]:[port] into a web browser. For example, http://localhost:4502.

2. Log in using admin as the user name and password.

3. Click CRXDE Lite.

4. From the left-side folder structure view, open /etc/aep/config/dataservices/destinations/remoting.

5. Right click the remoting folder and select Create, Create File.

6. Specify com.adobe.myexample.xml in the Name field.

7. Click OK.

8. Double click the com.adobe.myexample.xml file.

9. Enter the XML shown in this section that represents the echo destination.

10. From the top menu, click the Save All button.

To view server destinations

After you create a server destination, you can view it by using the Data Model perspective in a Flex Project for ADEP Experience Services project.

1. Change the pespective to Data Model by clicking Window, Open Perspective, Data Model.

2. View a destination by clicking Window, Show View, Destinations.

3. Look for remoting destinations by searching in the Remoting Destinations folder.

To create a Flex Project for ADEP Experience Services application

1. Start Flash Builder.

2. Click File, New, Other.

3. Select Flex Project for ADEP Experience Services and click Next.

4. In the Project Name box, specify a name for your project.

5. Under Application Type, select Web.

6. Keep the Flex SDK version 4.5 and click Next.

7. From the RDS server, select Experience Server (localhost).

8. Click the Configure button.

9. Select Experience Server.

10. In the Host Name box, specify the hostname or IP address of the Experience Server.

11. In the Port Number box, specify the Port Number.

12. In the User Name, specify a user name. Specify a the corresponding password in the Password box.

13. Determine if the project can communicate with the server by clicking the Test Connection button. If communication is successful, then a message that states that the test connection is successful is displayed.

14. Click OK.

15. Click Finish.

16. Add the code displayed earlier to the MXML file.

17. Click Project, Build All.

18. Run the client application from your Flash Builder development environment by clicking the Run button.